Organizations
Adds the current user to the organization with the invitation's roles. An existing member keeps their current roles.
user_jwtAuthorizationBearer <token>Bearer access token for a signed-in user.
application/json- body
token*stringThe invitation token.
The organization member
application/json- response
assignable_project_permissions*array<string>The project permissions the member may grant.
email*stringThe member's email address.
joined_at*stringWhen the user joined the organization.
date-timename?|The member's display name.
org_permissions*array<string>The member's effective organization permissions.
roles*array<string>The assigned role identifiers.
user_id*stringThe user ID.
uuidcurl -X POST 'https://example.com/invitations/accept' \ -H 'Content-Type: application/json' \ -d '{ "token": "string"}'{ "assignable_project_permissions": [ "string" ], "email": "string", "joined_at": "2019-08-24T14:15:22Z", "name": "string", "org_permissions": [ "string" ], "roles": [ "string" ], "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"}Marks the invitation as declined until it is revoked or re-issued.
user_jwtAuthorizationBearer <token>Bearer access token for a signed-in user.
application/json- body
token*stringThe invitation token.
Invitation declined
curl -X POST 'https://example.com/invitations/decline' \ -H 'Content-Type: application/json' \ -d '{ "token": "string"}'Looks up a pending invitation before the invitee accepts or declines it.
user_jwtAuthorizationBearer <token>Bearer access token for a signed-in user.
application/json- body
token*stringThe invitation token.
The pending invitation
application/json- response
What POST /invitations/lookup shows the token holder before they decide.
email*stringThe invited address — the one the email went to.
expires_at*stringWhen the invitation expires.
date-timeid*stringThe invitation ID.
uuidinvited_by?|The inviter's display name, else their email; null when the
inviting account no longer exists.
org_id*stringThe organization ID.
uuidorg_name*stringThe organization name.
roles*array<string>The role identifiers granted on acceptance.
curl -X POST 'https://example.com/invitations/lookup' \ -H 'Content-Type: application/json' \ -d '{ "token": "string"}'{ "email": "string", "expires_at": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "invited_by": "string", "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "org_name": "string", "roles": [ "string" ]}user_jwtAuthorizationBearer <token>Bearer access token for a signed-in user.
limit?integerMaximum number of items to return, 1–200 (default 100)
int641 <= value <= 200100cursor?stringOpaque continuation token returned as next_cursor by a previous request
The page of organizations
application/json- response
A page of organizations.
next_cursor?|The cursor for the next page, or null when this is the last page.
organizations*array<>The organizations in this page.
curl -X GET 'https://example.com/orgs'{ "next_cursor": "string", "organizations": [ { "budget_stop_grace_seconds": 0, "created_at": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "max_sandbox_timeout_seconds": 0, "name": "string", "personal": true, "preview_warning_disabled": true, "sso_linked": true, "sso_organization_id": "string", "suspended": true, "suspended_reason": "string", "updated_at": "2019-08-24T14:15:22Z", "v0_membership_sync_enabled": true, "v1_membership_sync_enabled": true, "membership": { "default_project_id": "1226a120-3a85-4fe0-bba2-cdfc7af0d81b", "grantable_project_permissions": [ "string" ], "permissions": [ "string" ], "roles": [ "string" ] } } ]}Creates a non-personal organization and adds the current user as its initial administrator.
user_jwtAuthorizationBearer <token>Bearer access token for a signed-in user.
application/json- body
name*stringThe organization name.
The created organization
application/json- response
An organization.
budget_stop_grace_seconds*integerThe delay before budget-held sandboxes are stopped or deleted; macOS sandboxes, which run on a prepaid Mac reservation, keep running.
int64created_at*stringWhen the organization was created.
date-timeid*stringThe organization ID.
uuidmax_sandbox_timeout_seconds*|The longest timeout a sandbox in this organization may have, in seconds; null uses the platform maximum.
int32name*stringThe organization name.
personal*booleanWhether this is the user's personal organization.
preview_warning_disabled*booleanWhether sandbox previews skip the warning page.
sso_linked*booleanWhether the organization is linked to its single sign-on configuration.
sso_organization_id*|The ID of the single sign-on organization the organization is linked
to; null when sso_linked is false.
suspended*booleanWhether new resource creation is suspended.
suspended_reason?|The member-visible suspension reason, when available.
updated_at*stringWhen the organization was last updated.
date-timev0_membership_sync_enabled*booleanWhether membership changes sync with the Daytona v0 organization of the same ID. When true, removing a member also removes them from the Daytona v0 organization.
v1_membership_sync_enabled*booleanDeprecatedDeprecated: use v0_membership_sync_enabled, which carries the same
value.
curl -X POST 'https://example.com/orgs' \ -H 'Content-Type: application/json' \ -d '{ "name": "string"}'{ "budget_stop_grace_seconds": 0, "created_at": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "max_sandbox_timeout_seconds": 0, "name": "string", "personal": true, "preview_warning_disabled": true, "sso_linked": true, "sso_organization_id": "string", "suspended": true, "suspended_reason": "string", "updated_at": "2019-08-24T14:15:22Z", "v0_membership_sync_enabled": true, "v1_membership_sync_enabled": true}user_jwt read:organizationAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: read:organization
org_id*stringThe organization ID
uuidThe organization
application/json- response
An organization.
budget_stop_grace_seconds*integerThe delay before budget-held sandboxes are stopped or deleted; macOS sandboxes, which run on a prepaid Mac reservation, keep running.
int64created_at*stringWhen the organization was created.
date-timeid*stringThe organization ID.
uuidmax_sandbox_timeout_seconds*|The longest timeout a sandbox in this organization may have, in seconds; null uses the platform maximum.
int32name*stringThe organization name.
personal*booleanWhether this is the user's personal organization.
preview_warning_disabled*booleanWhether sandbox previews skip the warning page.
sso_linked*booleanWhether the organization is linked to its single sign-on configuration.
sso_organization_id*|The ID of the single sign-on organization the organization is linked
to; null when sso_linked is false.
suspended*booleanWhether new resource creation is suspended.
suspended_reason?|The member-visible suspension reason, when available.
updated_at*stringWhen the organization was last updated.
date-timev0_membership_sync_enabled*booleanWhether membership changes sync with the Daytona v0 organization of the same ID. When true, removing a member also removes them from the Daytona v0 organization.
v1_membership_sync_enabled*booleanDeprecatedDeprecated: use v0_membership_sync_enabled, which carries the same
value.
curl -X GET 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "budget_stop_grace_seconds": 0, "created_at": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "max_sandbox_timeout_seconds": 0, "name": "string", "personal": true, "preview_warning_disabled": true, "sso_linked": true, "sso_organization_id": "string", "suspended": true, "suspended_reason": "string", "updated_at": "2019-08-24T14:15:22Z", "v0_membership_sync_enabled": true, "v1_membership_sync_enabled": true}Updates the fields present in the request body. The name is trimmed and must contain 1 to 100 characters with no control characters.
user_jwt write:organizationAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: write:organization
org_id*stringThe organization ID
uuidapplication/json- body
max_sandbox_timeout_seconds?|The longest timeout a sandbox in this organization may have, in seconds; null uses the platform maximum.
int64name?stringThe replacement organization name.
The organization
application/json- response
An organization.
budget_stop_grace_seconds*integerThe delay before budget-held sandboxes are stopped or deleted; macOS sandboxes, which run on a prepaid Mac reservation, keep running.
int64created_at*stringWhen the organization was created.
date-timeid*stringThe organization ID.
uuidmax_sandbox_timeout_seconds*|The longest timeout a sandbox in this organization may have, in seconds; null uses the platform maximum.
int32name*stringThe organization name.
personal*booleanWhether this is the user's personal organization.
preview_warning_disabled*booleanWhether sandbox previews skip the warning page.
sso_linked*booleanWhether the organization is linked to its single sign-on configuration.
sso_organization_id*|The ID of the single sign-on organization the organization is linked
to; null when sso_linked is false.
suspended*booleanWhether new resource creation is suspended.
suspended_reason?|The member-visible suspension reason, when available.
updated_at*stringWhen the organization was last updated.
date-timev0_membership_sync_enabled*booleanWhether membership changes sync with the Daytona v0 organization of the same ID. When true, removing a member also removes them from the Daytona v0 organization.
v1_membership_sync_enabled*booleanDeprecatedDeprecated: use v0_membership_sync_enabled, which carries the same
value.
curl -X PATCH 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{}'{ "budget_stop_grace_seconds": 0, "created_at": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "max_sandbox_timeout_seconds": 0, "name": "string", "personal": true, "preview_warning_disabled": true, "sso_linked": true, "sso_organization_id": "string", "suspended": true, "suspended_reason": "string", "updated_at": "2019-08-24T14:15:22Z", "v0_membership_sync_enabled": true, "v1_membership_sync_enabled": true}Deletes an organization after confirming that no active resources block removal.
user_jwt delete:organizationAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: delete:organization
org_id*stringThe organization ID
uuidOrganization deleted
curl -X DELETE 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08'Returns audit logs newest first. The actor_created_by field is null when the caller cannot view organization members. Filters use field[op]=value, where op is eq, not, in, not_in, gt, gte, lt, or lte.
AuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: read:audit
org_id*stringThe organization ID
uuidlimit?integerMaximum number of items to return, 1–200 (default 100)
int641 <= value <= 200100cursor?stringOpaque continuation token returned as next_cursor by a previous request
action?stringThe action filter
target_type?stringThe target resource type filter
target_id?stringThe target resource ID filter
actor?stringThe actor user or API key ID
uuidstatus?integerThe response status code filter
int32start_at?stringThe inclusive start of the time range
date-timeend_at?stringThe exclusive end of the time range
date-timeThe page of audit logs
application/json- response
audit_logs*array<>The audit log entries.
next_cursor?|The cursor for the next page, or null at the end.
curl -X GET 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/audit-logs'{ "audit_logs": [ { "action": "string", "actor_created_by": "35765c86-3f6c-4c27-b840-a0903bbdedd6", "actor_email": "string", "actor_key_id": "b9a81dca-0dc5-41dd-a51c-3cd1a6ec03ff", "actor_key_prefix": "string", "actor_kind": "string", "actor_service_account_id": "f8d1a8f6-34ae-45b6-8962-16779520eaec", "actor_user_id": "d6ed4497-4325-4995-9f49-e288b7192e46", "created_at": "2019-08-24T14:15:22Z", "error_message": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "ip_address": "string", "metadata": {}, "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9", "status_code": 0, "target_id": "string", "target_type": "string", "user_agent": "string" } ], "next_cursor": "string"}user_jwt read:auditAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: read:audit
org_id*stringThe organization ID
uuidThe audit configuration
application/json- response
disabled*booleanWhether audit capture is disabled.
curl -X GET 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/audit-logs/config'{ "disabled": true}Enables or disables capture for future organization actions.
user_jwt write:auditAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: write:audit
org_id*stringThe organization ID
uuidapplication/json- body
disabled*booleanWhether to disable audit capture.
The audit configuration
application/json- response
disabled*booleanWhether audit capture is disabled.
curl -X PATCH 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/audit-logs/config' \ -H 'Content-Type: application/json' \ -d '{ "disabled": true}'{ "disabled": true}Returns every entitlement key and whether it is available to the organization.
user_jwt read:organizationAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: read:organization
org_id*stringThe organization ID
uuidThe organization's entitlements
application/json- response
The entitlements available to an organization.
entitlements*Every entitlement key, true when it is available to the
organization.
curl -X GET 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/entitlements'{ "entitlements": { "property1": true, "property2": true }}user_jwt read:organizationAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: read:organization
org_id*stringThe organization ID
uuidThe organization feature flags
application/json- response
flags*The published feature keys enabled for the organization. Disabled keys are omitted.
curl -X GET 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/feature-flags'{ "flags": { "property1": true, "property2": true }}Returns pending, declined, and expired invitations newest first.
user_jwt read:membersAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: read:members
org_id*stringThe organization ID
uuidlimit?integerMaximum number of items to return, 1–200 (default 100)
int641 <= value <= 200100cursor?stringOpaque continuation token returned as next_cursor by a previous request
The page of organization invitations
application/json- response
invitations*array<>The organization invitations.
next_cursor?|The cursor for the next page, or null at the end.
curl -X GET 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/invitations'{ "invitations": [ { "created_at": "2019-08-24T14:15:22Z", "declined_at": "2019-08-24T14:15:22Z", "email": "string", "expires_at": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "roles": [ "string" ], "status": "pending" } ], "next_cursor": "string"}Creates an invitation or re-issues an existing invitation for the same email address. Members join an organization by looking up and accepting the invitation link; they may decline it instead.
user_jwt write:membersAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: write:members
org_id*stringThe organization ID
uuidapplication/json- body
email*stringThe email address to invite.
roles?array<string>|Absent ⇒ ["developer"]; an explicit empty array is a 400.
1 <= itemsThe invitation, updated
application/json- response
created_at*stringWhen the invitation was created or last re-issued.
date-timedeclined_at?|When the invitation was declined, or null.
date-timeemail*stringThe invited email address.
expires_at*stringWhen the invitation expires.
date-timeid*stringThe invitation ID.
uuidorg_id*stringThe organization ID.
uuidroles*array<string>The role identifiers granted on acceptance.
status*InvitationStatusThe invitation status.
"pending""declined""expired"accept_url?|The invitation acceptance URL, or null when it was delivered by email.
curl -X POST 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/invitations' \ -H 'Content-Type: application/json' \ -d '{ "email": "string"}'{ "created_at": "2019-08-24T14:15:22Z", "declined_at": "2019-08-24T14:15:22Z", "email": "string", "expires_at": "2019-08-24T14:15:22Z", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "roles": [ "string" ], "status": "pending", "accept_url": "string"}Invalidates an invitation that has not been accepted.
user_jwt write:membersAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: write:members
org_id*stringThe organization ID
uuidinvitation_id*stringThe invitation ID
uuidInvitation revoked
curl -X DELETE 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/invitations/497f6eca-6276-4993-bfeb-53cbbbba6f08'Returns effective limits and current usage. A null limit means unlimited.
AuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: read:organization
org_id*stringThe organization ID
uuidThe organization's limits
application/json- response
api_keys_per_organization*The organization's live API-key limit and current usage.
api_keys_per_project*The organization's live API-key limit and current usage.
image_builds*Concurrent image-build limits.
members?Organization member limits. Omitted for project-scoped callers.
sandbox_resources?Per-sandbox resource maximums for Linux sandboxes. Omitted by API versions that predate them.
sandboxes*Sandbox count limits.
secrets_per_project*The organization's live API-key limit and current usage.
curl -X GET 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/limits'{ "api_keys_per_organization": { "limit": 0, "usage": 0 }, "api_keys_per_project": { "limit": 0, "usage": 0 }, "image_builds": { "concurrent": { "limit": 0, "usage": 0 } }, "members": { "limit": 0, "usage": 0, "pending_invitations": 0 }, "sandbox_resources": { "max_memory_mib": 0, "max_vcpus": 0 }, "sandboxes": { "concurrent": { "limit": 0, "usage": 0 }, "gpu_concurrent": { "limit": 0, "usage": 0 }, "total": { "limit": 0, "usage": 0 }, "windows_concurrent": { "limit": 0, "usage": 0 } }, "secrets_per_project": { "limit": 0, "usage": 0 }}user_jwt read:organizationAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: read:organization
org_id*stringThe organization ID
uuidThe macOS settings
application/json- response
An organization's macOS settings.
macos_auto_reserve*booleanWhether a macOS create buys a Mac reservation when the organization holds none in the region. On unless an admin turns it off.
macos_auto_reserve_disabled_at?|When an admin last turned auto-reserve off; null while it is on.
date-timemacos_auto_reserve_disabled_by?|The admin who last turned auto-reserve off; null while it is on, or when no admin was recorded.
uuidmacos_auto_reserve_max_reservations*integerThe most live auto-created reservations the org may hold at once.
int32curl -X GET 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/macos-settings'{ "macos_auto_reserve": true, "macos_auto_reserve_disabled_at": "2019-08-24T14:15:22Z", "macos_auto_reserve_disabled_by": "66e39aae-c839-4c51-b2e7-10cd6611e171", "macos_auto_reserve_max_reservations": 0}user_jwt write:organizationAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: write:organization
org_id*stringThe organization ID
uuidapplication/json- body
The macOS settings to change: any non-empty subset of the fields.
macos_auto_reserve?|Whether new macOS creates may automatically reserve capacity.
macos_auto_reserve_max_reservations?|Maximum number of automatically created reservations.
int32The macOS settings
application/json- response
An organization's macOS settings.
macos_auto_reserve*booleanWhether a macOS create buys a Mac reservation when the organization holds none in the region. On unless an admin turns it off.
macos_auto_reserve_disabled_at?|When an admin last turned auto-reserve off; null while it is on.
date-timemacos_auto_reserve_disabled_by?|The admin who last turned auto-reserve off; null while it is on, or when no admin was recorded.
uuidmacos_auto_reserve_max_reservations*integerThe most live auto-created reservations the org may hold at once.
int32curl -X PATCH 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/macos-settings' \ -H 'Content-Type: application/json' \ -d '{}'{ "macos_auto_reserve": true, "macos_auto_reserve_disabled_at": "2019-08-24T14:15:22Z", "macos_auto_reserve_disabled_by": "66e39aae-c839-4c51-b2e7-10cd6611e171", "macos_auto_reserve_max_reservations": 0}user_jwt read:membersAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: read:members
org_id*stringThe organization ID
uuidlimit?integerMaximum number of items to return, 1–200 (default 100)
int641 <= value <= 200100cursor?stringOpaque continuation token returned as next_cursor by a previous request
The page of organization members
application/json- response
members*array<>The organization members.
next_cursor?|The cursor for the next page, or null at the end.
curl -X GET 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/members'{ "members": [ { "assignable_project_permissions": [ "string" ], "email": "string", "joined_at": "2019-08-24T14:15:22Z", "name": "string", "org_permissions": [ "string" ], "roles": [ "string" ], "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5" } ], "next_cursor": "string"}Replaces the member's complete role set.
user_jwt write:membersAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: write:members
org_id*stringThe organization ID
uuiduser_id*stringThe user ID
uuidapplication/json- body
roles*array<string>The member's complete new role set. Required, with at least one role.
1 <= itemsThe organization member
application/json- response
assignable_project_permissions*array<string>The project permissions the member may grant.
email*stringThe member's email address.
joined_at*stringWhen the user joined the organization.
date-timename?|The member's display name.
org_permissions*array<string>The member's effective organization permissions.
roles*array<string>The assigned role identifiers.
user_id*stringThe user ID.
uuidcurl -X PATCH 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/members/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{ "roles": [ "string" ]}'{ "assignable_project_permissions": [ "string" ], "email": "string", "joined_at": "2019-08-24T14:15:22Z", "name": "string", "org_permissions": [ "string" ], "roles": [ "string" ], "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"}AuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: read:organization
org_id*stringThe organization ID
uuiduser_id*stringThe user ID
uuidMember removed
curl -X DELETE 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/members/497f6eca-6276-4993-bfeb-53cbbbba6f08'Shows the credentials and preview grants that removal would revoke.
AuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: read:organization
org_id*stringThe organization ID
uuiduser_id*stringThe user ID
uuidThe member removal preview
application/json- response
revoked_api_keys*integerThe number of API keys the removal would revoke.
int64revoked_preview_grants?|The number of signed preview grants the removal would delete, or
null when unknown.
int64user_id*stringThe user ID that would be removed.
uuidcurl -X GET 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/members/497f6eca-6276-4993-bfeb-53cbbbba6f08/removal-preview'{ "revoked_api_keys": 0, "revoked_preview_grants": 0, "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"}user_jwt write:membersAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: write:members
org_id*stringThe organization ID
uuiduser_id*stringThe user ID
uuidapplication/json- body
roles*array<string>The member's complete new role set.
1 <= itemsThe change impact
application/json- response
revoked_api_keys*integerThe number of API keys the change would revoke.
int640 <= valuerevoked_preview_grants*integerThe number of preview grants the change would revoke.
int640 <= valuecurl -X POST 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/members/497f6eca-6276-4993-bfeb-53cbbbba6f08/update-preview' \ -H 'Content-Type: application/json' \ -d '{ "roles": [ "string" ]}'{ "revoked_api_keys": 0, "revoked_preview_grants": 0}Header values are write-only and are never returned.
user_jwt read:organizationAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: read:organization
org_id*stringThe organization ID
uuidThe telemetry configuration
application/json- response
An organization's telemetry configuration: the endpoint and the names of the configured request headers. Header values are write-only and are never returned.
created_at*|When the configuration was created, or null when it is unset.
date-timeendpoint*|The tenant's OTLP/HTTP endpoint.
header_names*array<string>Names of the request headers configured; values are write-only and never returned.
updated_at*|When the configuration was last updated, or null when it is unset.
date-timecurl -X GET 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/otel-config'{ "created_at": "2019-08-24T14:15:22Z", "endpoint": "string", "header_names": [ "string" ], "updated_at": "2019-08-24T14:15:22Z"}Stops forwarding sandbox telemetry for the organization.
user_jwt write:organizationAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: write:organization
org_id*stringThe organization ID
uuidTelemetry configuration reset
curl -X DELETE 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/otel-config'Replaces the forwarding endpoint and request headers. Header values are write-only, and an unknown request field is rejected.
user_jwt write:organizationAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: write:organization
org_id*stringThe organization ID
uuidapplication/json- body
The telemetry configuration to set. headers defaults to empty, and an
unknown field is rejected with 400.
endpoint*stringOTLP/HTTP endpoint (https://…; plaintext http only where the deployment allows insecure endpoints).
headers?Request headers sent to the endpoint, name → value. Values are write-only: no read returns them.
The telemetry configuration
application/json- response
An organization's telemetry configuration: the endpoint and the names of the configured request headers. Header values are write-only and are never returned.
created_at*|When the configuration was created, or null when it is unset.
date-timeendpoint*|The tenant's OTLP/HTTP endpoint.
header_names*array<string>Names of the request headers configured; values are write-only and never returned.
updated_at*|When the configuration was last updated, or null when it is unset.
date-timecurl -X PUT 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/otel-config' \ -H 'Content-Type: application/json' \ -d '{ "endpoint": "string"}'{ "created_at": "2019-08-24T14:15:22Z", "endpoint": "string", "header_names": [ "string" ], "updated_at": "2019-08-24T14:15:22Z"}Turns the preview warning page off or on for the organization's sandbox previews. When plan requirements are enforced, turning it off requires this setting to be included in the organization's plan; turning it on does not.
user_jwt write:organizationAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: write:organization
org_id*stringThe organization ID
uuidapplication/json- body
Turns the preview warning page off or on. Unknown fields are rejected.
disabled*booleantrue turns the preview warning page off for every sandbox preview of
the organization (needs the preview_warning_opt_out entitlement where
enforcement is on); false turns it back on.
The preview warning setting
application/json- response
An organization's preview-warning setting.
disabled*booleanWhether sandbox previews skip the warning page.
curl -X PATCH 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/preview-warning' \ -H 'Content-Type: application/json' \ -d '{ "disabled": true}'{ "disabled": true}Lists the single sign-on connections configured for the organization. An organization that has not completed setup has no connections.
user_jwt read:ssoAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: read:sso
org_id*stringThe organization ID
uuidlimit?integerMaximum number of items to return, 1–200 (default 100)
int641 <= value <= 200100cursor?stringOpaque continuation token returned as next_cursor by a previous request
The page of single sign-on connections
application/json- response
connections*array<>The organization's single sign-on connections.
next_cursor?|Opaque continuation token for the next page, or null on the last page.
curl -X GET 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/connections'{ "connections": [ { "connection_type": "string", "created_at": "2019-08-24T14:15:22Z", "domains": [ "string" ], "id": "string", "name": "string", "status": "string", "updated_at": "2019-08-24T14:15:22Z" } ], "next_cursor": "string"}Creates a short-lived link for configuring single sign-on or directory sync. The link expires five minutes after issuance.
user_jwt write:ssoAuthorizationBearer <token>Bearer access token for a signed-in user.
Scope: write:sso
org_id*stringThe organization ID
uuidapplication/json- body
Settings for creating a single sign-on setup link.
intent*PortalIntentThe setup area to open: sso for single sign-on or dsync for directory sync.
"sso""dsync"The created single sign-on setup link
application/json- response
url*stringThe setup URL, which expires five minutes after issuance.
curl -X POST 'https://example.com/orgs/497f6eca-6276-4993-bfeb-53cbbbba6f08/sso/setup-links' \ -H 'Content-Type: application/json' \ -d '{ "intent": "sso"}'{ "url": "string"}