Select Friend
Atlassian
Resource Type
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| label | string | Key label | |
| createdAt | number | Creation timestamp (RFC 3339) | |
| expiresAt | number | Expiration timestamp (RFC 3339) | |
| orgId | string | Organization | Organization the key belongs to |
| scopes | list<string> | Scopes granted to the key | |
| lastActiveAt | number | Last use 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. | |
| string | Email of the API key user. | ||
| revokedBy | string | Principal that revoked the key | |
| revocationDate | number | Revocation timestamp (RFC 3339) | |
| id | string | The key ID generated in the token-service. |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| createdAt | number | Creation timestamp (RFC 3339) | |
| 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. | |
| string | Email of the API token user. | ||
| orgId | string | Org ID of the API token user. | |
| label | string | Token label | |
| status | string | Token status | |
| org_id | string | Organization | Organization ID |
| id | string | The token ID generated in the token-service. | |
| scopes | list<string> | Array of scopes associated with the token. An empty array indicates an unscoped API token. |
| 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 | |
| type | string | Claim type. Valid values are http, dns. | |
| status | string | Verification Status of the Domain Claim. | |
| 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 |
|---|---|---|---|
| attributes | object | Policy attributes | |
| type | string | Type of this 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 | |
| export | object | Content export control (data-security policies) | |
| effect | string | Effect of the control. Valid values are allow, block. | |
| attachmentDownload | object | Attachment download control (data-security policies) | |
| effect | string | Effect of the control. Valid values are allow, block. | |
| apiTokenAccessMode | string | Whether external users may use API tokens (external-user-security policies). Valid values are ALLOW, BLOCK. | |
| stepUpSessionDurationMinutes | number | Step-up re-authentication session duration in minutes (external-user-security policies) | |
| off | list<string> | Notification types turned off (admin-notification-settings policies) | |
| in | list<string> | Data residency realms selected (data-residency policies) | |
| appAccess | object | Marketplace app access control (data-security policies) | |
| effect | string | Effect of the control. 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. | |
| anonymousAccess | object | Anonymous access control (data-security policies) | |
| effect | string | Effect of the control. Valid values are allow, block. | |
| queryData | string | Internal query key identifying the policy | |
| updatedAt | number | Last update timestamp (RFC 3339) | |
| name | string | Policy name | |
| status | string | Policy status | |
| ownerId | string | Organization that owns the policy | |
| resources | list<object> | Resources the policy applies to | |
| id | string | ARI of the resource the policy is applied to | |
| applicationStatus | string | Status of policy application on resource | |
| createdAt | number | When the policy was applied to this resource (RFC 3339) | |
| updatedAt | number | When this resource application was last updated (RFC 3339) | |
| metadata | object | Policy metadata including authorship and coverage | |
| systemTag | string | ARI of the classification tag associated with the policy | |
| txt | object | TXT DNS record check result (custom-domain-email-notification policies) | |
| 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) | |
| domain | string | Domain the TXT record was checked against | |
| cname | list<object> | CNAME DNS record check results, one per DKIM selector (custom-domain-email-notification policies) | |
| status | string | DNS check status (for example CUSTOMER_DNS_ERROR) | |
| statusExtended | string | Detailed DNS check status (for example MISSING_CONFIG) | |
| domain | string | DKIM selector domain the CNAME record was checked against | |
| value | string | Expected CNAME record value | |
| 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) | |
| createdBy | string | ARI of the user who created the policy | |
| policyCoverageLevel | string | Scope the policy applies at (for example WORKSPACE) | |
| 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 | |
| spf | object | SPF DNS record check result (custom-domain-email-notification policies) | |
| status | string | DNS check status (for example CUSTOMER_DNS_ERROR) | |
| statusExtended | string | Detailed DNS check status (for example MISSING_CONFIG) | |
| domain | string | Domain the SPF record was checked against | |
| value | string | Expected SPF record value | |
| bounceCname | object | Bounce CNAME DNS record check result (custom-domain-email-notification policies) | |
| statusExtended | string | Detailed DNS check status (for example MISSING_CONFIG) | |
| 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) | |
| lastUpdatedBy | string | ARI of the user who last updated the policy | |
| hasHadCoverage | boolean | Whether the policy has ever covered a resource | |
| status | string | Roll-up DNS verification status across spf, txt, cname and bounceCname (custom-domain-email-notification policies; for example CUSTOMER_DNS_ERROR) | |
| subject | object | Subject the policy targets | |
| subjectType | string | Type of subject (for example marketplaceApp) | |
| subjectId | string | Identifier of the subject (for example all_apps) | |
| createdAt | number | Creation timestamp (RFC 3339) | |
| id | string | Policy ID (UUID) | |
| id | string | Unique identifier of the Policy. | |
| message | string | Message returned with the policy, if any | |
| type | string | Type of this object. Valid value is policy. | |
| org_id | string | Organization | Organization ID |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|---|---|---|
| appType | string | Atlassian product the workspace belongs to | |
| attributes | object | Workspace attributes | |
| statusDetails | list<object> | Additional detail about the workspace status | |
| unit | string | Workspace unit | |
| labels | list<string> | Workspace labels | |
| name | string | Workspace name | |
| typeKey | string | Workspace type key | |
| createdAt | number | Workspace creation timestamp (RFC 3339) | |
| hostUrl | string | Workspace host URL | |
| icons | object | Workspace icons keyed by size | |
| avatars | object | Workspace avatars keyed by size | |
| realm | string | Data residency realm the workspace is pinned to | |
| regions | list<string> | Regions the workspace data is stored in | |
| type | string | Workspace type | |
| owner | string | Workspace owner | |
| status | string | Workspace status | |
| directory | string | Identity directory backing the workspace | |
| 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 | |
| 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) | |
| plan | string | Licence plan display name (for example Premium) | |
| policy | list<object> | Policies applied to the workspace | |
| id | string | Policy identifier (for example ai, customDomains) | |
| 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 | |
| enabled | boolean | Whether the policy is enabled (the AI-consent flag) | |
| 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. | |
| feature | list<object> | Features enabled on the workspace | |
| links | object | Hypermedia links for the feature | |
| self | string | Canonical URL of this workspace feature | |
| attributes | object | Workspace feature attributes | |
| enabled | boolean | Whether the feature is enabled | |
| isEntitled | boolean | Whether the workspace is entitled to the feature | |
| ip | number | Number of configured IP allowlist entries | |
| isDataResidencyAllowed | boolean | Whether data residency pinning is permitted | |
| entitledSandbox | string | Sandbox entitlement tier | |
| realms | list<string> | Data residency realms available to the workspace | |
| portal | object | Custom domain limit for the portal target | |
| limit | number | Maximum number of custom domains | |
| parent | object | Custom domain limit for the parent target | |
| limit | number | Maximum number of custom domains | |
| userAccessManagementState | string | User access management state for the workspace | |
| tracks | list<string> | Release tracks the workspace is subscribed to | |
| type | string | Feature type | |
| isEnabled | boolean | Whether the feature is enabled (insights) | |
| limit | number | Numeric limit associated with the feature | |
| self | object | Custom domain limit for the workspace itself | |
| limit | number | Maximum number of custom domains | |
| 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 | |
| id | string | Feature identifier | |
| type | string | Type name of this object. Valid value is features. | |
| 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 | |
| entitlementId | string | ID of the related entitlement | |
| relationshipType | string | Nature of the relationship (for example FAMILY_CONTAINER) | |
| type | string | Type name of this object. Valid value is workspaces. | |
| org_id | string | Organization | Organization ID |
| ATTRIBUTE | TYPE | REFERS TO | DESCRIPTION |
|---|