ATTRIBUTE TYPE REFERS TO DESCRIPTION
createdAt number Creation timestamp (RFC 3339)
orgId string Organization Organization the key belongs to
revocationDate number Revocation timestamp (RFC 3339)
scopes list<string> Scopes granted to the key
lastActiveAt number Last use timestamp (RFC 3339)
expiresAt number Expiration timestamp (RFC 3339)
resource string Resource the key is scoped to (an ARI)
createdBy object User that created the key
 id string User ID of the API key user.
 name string Name of the API key user.
 email string Email of the API key user.
revokedBy string Principal that revoked the key
id string The key ID generated in the token-service.
label string Key label
ATTRIBUTE TYPE REFERS TO DESCRIPTION
scopes list<string> Array of scopes associated with the token. An empty array indicates an unscoped API token.
lastActiveAt number Last use timestamp (RFC 3339)
expiresAt number Expiration timestamp (RFC 3339)
user object The user associated with the token.
 id string User ID of the API token user.
 name string Name of the API token user.
 email string Email of the API token user.
 orgId string Org ID of the API token user.
status string Token status
createdAt number Creation timestamp (RFC 3339)
org_id string Organization Organization ID
id string The token ID generated in the token-service.
label string Token label
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
directoryId string Unique directory identifier.
name string Directory name
icon string Directory icon URL
org_id string Organization Organization ID
ATTRIBUTE TYPE REFERS TO DESCRIPTION
attributes object Domain attributes
 name string Domain name
 claim object Domain claim details
 status string Verification Status of the Domain Claim.
 type string Claim type. Valid values are http, dns.
id string Unique identifier of the Domain
links object Hypermedia links for the domain
 self string Canonical URL of this domain
type string Type name of this object. Valid value is domains.
org_id string Organization Organization ID
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
type string Type name of this object. Valid value is orgs.
org_id string Organization Organization ID
attributes object Organization attributes
 name string Organization name
id string Unique identifier of the Org
links object Hypermedia links for the organization
 self string Canonical URL of this organization
relationships object Related collections exposed by the organization
 domains object Link to the organization's claimed domains collection
 related string URL of the domains collection
 users object Link to the organization's managed users collection
 related string URL of the users collection
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
org_id string Organization Organization ID
attributes object Policy attributes
 status string Policy status
 ownerId string Organization that owns the policy
 rule object Policy rule definition. Shape varies by policy type (for example {"in":["us"]} for data-residency, {"consented":true} for generative-ai); the hipaa policy returns an empty array instead of an object, so its contents cannot be modeled here
 allowMobileBypass boolean Whether mobile clients may bypass the IP allow list (ip-allowlist policies)
 apiTokenAccessMode string Whether external users may use API tokens (external-user-security policies). Valid values are ALLOW, BLOCK.
 emailAndNotificationsAccessMode string Whether external users may access email and notifications (external-user-security policies). Valid values are ALLOW, BLOCK.
 consented boolean Whether generative AI use has been consented to (generative-ai policies)
 domain list<string> Custom domains configured (custom-domain-email-notification policies)
 publicLinks object Public link sharing control (data-security policies)
 effect string Effect of the control. Valid values are allow, block.
 addedAt number When this control was added (RFC 3339)
 lastUpdatedAt number When this control was last updated (RFC 3339)
 export object Content export control (data-security policies)
 effect string Effect of the control. Valid values are allow, block.
 blockPageExport boolean Whether exporting whole pages is blocked (data-security policies)
 addedAt number When this control was added (RFC 3339)
 lastUpdatedAt number When this control was last updated (RFC 3339)
 attachmentDownload object Attachment download control (data-security policies)
 effect string Effect of the control. Valid values are allow, block.
 addedAt number When this control was added (RFC 3339)
 lastUpdatedAt number When this control was last updated (RFC 3339)
 appAccess object Marketplace app access control (data-security policies)
 effect string Effect of the control. Valid values are allow, block.
 addedAt number When this control was added (RFC 3339)
 lastUpdatedAt number When this control was last updated (RFC 3339)
 stepUpSessionDurationMinutes number Step-up re-authentication session duration in minutes (external-user-security policies)
 type string External-user-security rule type (for example stepUpEmailAll)
 in list<string> Data residency realms selected (data-residency policies) or allowed IP addresses (ip-allowlist policies)
 off list<string> Notification types turned off (admin-notification-settings policies)
 anonymousAccess object Anonymous access control (data-security policies)
 addedAt number When this control was added (RFC 3339)
 lastUpdatedAt number When this control was last updated (RFC 3339)
 effect string Effect of the control. Valid values are allow, block.
 scope string Scope the external-user-security rule applies to (for example testPolicy)
 users list<string> Users the external-user-security rule targets (empty when the rule applies to all users)
 metadata object Policy metadata including authorship and coverage
 description string Policy description
 customerType string Customer tier the ugc-data-use-preferences policy applies to (for example premium)
 isSubDomain boolean Whether the custom domain is a subdomain (custom-domain-email-notification policies)
 lastCheckedTimeStamp number When the policy's DNS records were last checked (custom-domain-email-notification policies; RFC 3339)
 lastUpdatedBy string ARI of the user who last updated the policy
 systemTag string ARI of the classification tag associated with the policy
 spf object SPF DNS record check result (custom-domain-email-notification policies)
 domain string Domain the SPF record was checked against
 value string Expected SPF record value
 status string DNS check status (for example CUSTOMER_DNS_ERROR)
 statusExtended string Detailed DNS check status (for example MISSING_CONFIG)
 txt object TXT DNS record check result (custom-domain-email-notification policies)
 domain string Domain the TXT record was checked against
 value string Expected TXT record value
 status string DNS check status (for example CUSTOMER_DNS_ERROR)
 statusExtended string Detailed DNS check status (for example MISSING_CONFIG)
 bounceCname object Bounce CNAME DNS record check result (custom-domain-email-notification policies)
 domain string Domain the bounce CNAME record was checked against
 value string Expected bounce CNAME record value
 status string DNS check status (for example CUSTOMER_DNS_ERROR)
 statusExtended string Detailed DNS check status (for example MISSING_CONFIG)
 billingType string Billing type of the org for this policy (external-user-security policies; for example nonBillable)
 consentDisplayText string Consent text shown to users (generative-ai policies)
 migrationStatus string Policy migration status (for example V2_READY)
 createdBy string ARI of the user who created the policy
 contributeRawUgcData boolean Whether raw user-generated content may be used for model training (ugc-data-use-preferences policies)
 effectiveDate string Date the ugc-data-use-preferences policy setting takes effect
 status string Roll-up DNS verification status across spf, txt, cname and bounceCname (custom-domain-email-notification policies; for example CUSTOMER_DNS_ERROR)
 cname list<object> CNAME DNS record check results, one per DKIM selector (custom-domain-email-notification policies)
 domain string DKIM selector domain the CNAME record was checked against
 value string Expected CNAME record value
 status string DNS check status (for example CUSTOMER_DNS_ERROR)
 statusExtended string Detailed DNS check status (for example MISSING_CONFIG)
 coverageLastUpdatedAt number When the policy coverage was last updated (RFC 3339)
 validationTimestamp number When the policy was last validated (RFC 3339)
 hasHadCoverage boolean Whether the policy has ever covered a resource
 policyCoverageLevel string Scope the policy applies at (for example WORKSPACE)
 ai-rollout-cohort string AI rollout cohort the org is assigned to (generative-ai policies)
 coverageAddedAt number When the policy first gained coverage (RFC 3339)
 subject object Subject the policy targets
 subjectType string Type of subject (for example marketplaceApp)
 subjectId string Identifier of the subject (for example all_apps)
 queryData string Internal query key identifying the policy
 createdAt number Creation timestamp (RFC 3339)
 id string Policy ID (UUID)
 name string Policy name
 resources list<object> Resources the policy applies to
 createdAt number When the policy was applied to this resource (RFC 3339)
 updatedAt number When this resource application was last updated (RFC 3339)
 type string Type of the resource the policy is applied to (for example workspace)
 metadata object Additional metadata for this resource application
 effectiveDate string Date the policy application takes effect (ugc-data-use-preferences policies)
 id string ARI of the resource the policy is applied to
 applicationStatus string Status of policy application on resource
 updatedAt number Last update timestamp (RFC 3339)
 type string Type of this Policy.
id string Unique identifier of the Policy.
links object Hypermedia links for the policy
 self string Canonical URL of this policy
message string Message returned with the policy, if any
type string Type of this object. Valid value is policy.
ATTRIBUTE TYPE REFERS TO DESCRIPTION
ATTRIBUTE TYPE REFERS TO DESCRIPTION
appType string Atlassian product the workspace belongs to
attributes object Workspace attributes
 regions list<string> Regions the workspace data is stored in
 type string Workspace type
 owner string Workspace owner
 icons object Workspace icons keyed by size
 avatars object Workspace avatars keyed by size
 name string Workspace name
 labels list<string> Workspace labels
 createdAt number Workspace creation timestamp (RFC 3339)
 typeKey string Workspace type key
 status string Workspace status
 statusDetails list<object> Additional detail about the workspace status
 hostUrl string Workspace host URL
 directory string Identity directory backing the workspace
 unit string Workspace unit
 realm string Data residency realm the workspace is pinned to
id string Workspace ID (an ARI)
links object Hypermedia links for the workspace
 self string Canonical URL of this workspace
relationships object Related entitlements, policies and features
 entitlement list<object> Entitlements associated with the workspace
 id string Entitlement ID
 type string Type name of this object. Valid value is entitlements.
 links object Hypermedia links for the entitlement
 self string Canonical URL of this entitlement
 attributes object Entitlement attributes
 plan string Licence plan display name (for example Premium)
 key string Product key (for example jira-servicedesk.ondemand)
 productId string Product ID
 billingSourceSystem string Billing source system (for example CCP)
 usageIdentifier string ARI identifying the metered usage resource
 softCapacityLimit number Soft user capacity limit for the plan
 ccpEntitlementId string Commerce platform entitlement ID
 planKey string Licence plan key (for example premium)
 policy list<object> Policies applied to the workspace
 type string Type name of this object. Valid value is policies.
 links object Hypermedia links for the policy
 self string Canonical URL of this workspace policy
 attributes object Workspace policy attributes
 suspended string Suspension state of the policy
 availableTargets number Number of targets available for a custom domain
 portal object Custom domain availability for the portal target
 availableForCustomDomain boolean Whether a custom domain can be used
 parent object Custom domain availability for the parent target
 availableForCustomDomain boolean Whether a custom domain can be used
 self object Custom domain availability for the workspace itself
 availableForCustomDomain boolean Whether a custom domain can be used
 type string Policy type.
 enabled boolean Whether the policy is enabled (the AI-consent flag)
 id string Policy identifier (for example ai, customDomains)
 feature list<object> Features enabled on the workspace
 id string Feature identifier
 type string Type name of this object. Valid value is features.
 links object Hypermedia links for the feature
 self string Canonical URL of this workspace feature
 attributes object Workspace feature attributes
 entitledSandbox string Sandbox entitlement tier
 realms list<string> Data residency realms available to the workspace
 isDataResidencyAllowed boolean Whether data residency pinning is permitted
 allInclusive boolean Whether the audit log captures all event types
 events list<string> Audit log event categories captured
 available boolean Whether the feature is available on this workspace
 isEnabled boolean Whether the feature is enabled (insights)
 ip number Number of configured IP allowlist entries
 enabled boolean Whether the feature is enabled
 userAccessManagementState string User access management state for the workspace
 parent object Custom domain limit for the parent target
 limit number Maximum number of custom domains
 self object Custom domain limit for the workspace itself
 limit number Maximum number of custom domains
 type string Feature type
 limit number Numeric limit associated with the feature
 tracks list<string> Release tracks the workspace is subscribed to
 portal object Custom domain limit for the portal target
 limit number Maximum number of custom domains
 isEntitled boolean Whether the workspace is entitled to the feature
 relatesFromEntitlement list<object> Entitlements this workspace is related from
 id string Relationship ID
 type string Type name of this object. Valid value is relatesFromEntitlements.
 links object Hypermedia links for the relationship
 self string Canonical URL of this relationship
 attributes object Relationship attributes
 relationshipType string Nature of the relationship (for example FAMILY_CONTAINER)
 entitlementId string ID of the related entitlement
type string Type name of this object. Valid value is workspaces.
org_id string Organization Organization ID
ATTRIBUTE TYPE REFERS TO DESCRIPTION