Delegated Grants
Delegated Grants
List delegated grants
Get delegated grant
Update delegated grant
Delete delegated grant
ModelsExpand Collapse
class Grant: …User authorization for a resource to be accessed on their behalf. The grant links the user, resource, and the provider that issued the grant.
User authorization for a resource to be accessed on their behalf. The grant links the user, resource, and the provider that issued the grant.
Unique identifier of the delegated grant
Entity creation timestamp
Date when grant expires
Organization that owns this grant
ID of the provider that issued this grant
Indicates whether a refresh token is stored for this grant. Grants with refresh tokens can be refreshed even after access token expiration.
ID of resource receiving grant
Granted OAuth scopes
status: Literal["active", "expired", "revoked"]
Entity update timestamp
Reference to the user granting permission
Zone this grant belongs to
Whether the grant is currently active (deprecated - use status instead)
Deprecatedprovider: Optional[Provider]A Provider is a system that supplies access to Resources and allows actors (Users or Applications) to authenticate.
A Provider is a system that supplies access to Resources and allows actors (Users or Applications) to authenticate.
Unique identifier of the provider
Entity creation timestamp
User specified identifier, unique within the zone
Human-readable name
Organization that owns this provider
owner_type: Literal["platform", "customer"]Who owns this provider. Platform-owned providers cannot be modified via API.
Who owns this provider. Platform-owned providers cannot be modified via API.
URL-safe identifier, unique within the zone
Entity update timestamp
Zone this provider belongs to
OAuth 2.0 client identifier
Indicates whether a client secret is configured
Human-readable description
metadata: Optional[Metadata]Provider metadata
Provider metadata
Icon URL
protocols: Optional[Protocols]Protocol-specific configuration
Protocol-specific configuration
oauth2: Optional[ProtocolsOauth2]OAuth 2.0 protocol configuration
OAuth 2.0 protocol configuration
OIDC issuer URL used for discovery and token validation.
Custom query parameters appended to authorization redirect URLs. Use for non-standard providers (e.g. Google prompt=consent, access_type=offline).
Whether to include the resource parameter in authorization requests.
The resource parameter value to include in authorization requests. Defaults to "resource" when authorization_resource_enabled is true.
The query parameter name for scopes in authorization requests. Defaults to "scope". Slack v2 uses "user_scope".
The separator character for scope values. Defaults to " " (space). Slack v2 uses ",".
Dot-separated path to the access token in the token response body. Defaults to "access_token". Slack v2 uses "authed_user.access_token".
openid: Optional[ProtocolsOpenid]OpenID Connect protocol configuration
OpenID Connect protocol configuration
Name of the OIDC claim carrying the stable external id used to correlate logins with externally provisioned (SCIM) users. Defaults to "sub". Set to "oid" for Entra, whose pairwise "sub" differs from the SCIM externalId.
Additional OIDC scopes to request from this provider during authentication (e.g. "groups"). Merged with the default scopes (openid, profile, email).
When true, logging out of the zone propagates the logout to this provider's end_session_endpoint (RP-initiated logout). Defaults to false.
Name of a top-level string claim in this provider's ID Token to use as the user identifier on user creation. When not set, the user's Keycard ID is used.
type: Optional[Literal["external", "keycard-vault", "keycard-sts"]]
Timestamp when this grant's tokens were last refreshed. Omitted if grant was never refreshed.
Deprecatedresource: Optional[Resource]A Resource is a system that exposes protected information or functionality. It requires authentication of the requesting actor, which may be a user or application, before allowing access.
A Resource is a system that exposes protected information or functionality. It requires authentication of the requesting actor, which may be a user or application, before allowing access.
Unique identifier of the resource
application_type: Literal["native", "web"]The expected type of client for this credential. Native clients must use localhost URLs for redirect_uris or URIs with custom schemes. Web clients must use https URLs and must not use localhost as the hostname.
The expected type of client for this credential. Native clients must use localhost URLs for redirect_uris or URIs with custom schemes. Web clients must use https URLs and must not use localhost as the hostname.
Entity creation timestamp
User specified identifier, unique within the zone
Human-readable name
Organization that owns this resource
owner_type: Literal["platform", "customer"]Who owns this resource. Platform-owned resources cannot be modified via API.
Who owns this resource. Platform-owned resources cannot be modified via API.
When true, the resource identifier is treated as a URI prefix, protecting all URLs that share the identifier as a prefix at path/query/fragment boundaries. Protocol and hostname must match exactly. When multiple prefix resources satisfy an identifier query, the resource with the longest prefix is matched.
URL-safe identifier, unique within the zone
Entity update timestamp
Zone this resource belongs to
Deprecatedapplication: Optional[Application]An Application is a software system with an associated identity that can access Resources. It may act on its own behalf (machine-to-machine) or on behalf of a user (delegated access).
An Application is a software system with an associated identity that can access Resources. It may act on its own behalf (machine-to-machine) or on behalf of a user (delegated access).
Unique identifier of the application
consent: Literal["implicit", "required"]Consent mode for the application. 'implicit' means consent is automatically granted, 'required' means explicit user consent is needed.
Consent mode for the application. 'implicit' means consent is automatically granted, 'required' means explicit user consent is needed.
Entity creation timestamp
Number of resource dependencies
User specified identifier, unique within the zone
Human-readable name
Organization that owns this application
owner_type: Literal["platform", "customer"]Who owns this application. Platform-owned applications cannot be modified via API.
Who owns this application. Platform-owned applications cannot be modified via API.
URL-safe identifier, unique within the zone
Entity update timestamp
Zone this application belongs to
Human-readable description
metadata: Optional[Metadata]Entity metadata
Entity metadata
Documentation URL
Icon URL
protocols: Optional[Protocols]Protocol-specific configuration
Protocol-specific configuration
oauth2: Optional[ProtocolsOauth2]OAuth 2.0 protocol configuration
OAuth 2.0 protocol configuration
OAuth 2.0 post-logout redirect URIs for this application
OAuth 2.0 redirect URIs for this application
ID of the application that provides this resource
Credential lifetime override in seconds. When set, overrides the default credential lifetime for this resource. When absent, the default from the provider or zone is used.
Deprecatedcredential_provider: Optional[Provider]A Provider is a system that supplies access to Resources and allows actors (Users or Applications) to authenticate.
A Provider is a system that supplies access to Resources and allows actors (Users or Applications) to authenticate.
Unique identifier of the provider
Entity creation timestamp
User specified identifier, unique within the zone
Human-readable name
Organization that owns this provider
owner_type: Literal["platform", "customer"]Who owns this provider. Platform-owned providers cannot be modified via API.
Who owns this provider. Platform-owned providers cannot be modified via API.
URL-safe identifier, unique within the zone
Entity update timestamp
Zone this provider belongs to
OAuth 2.0 client identifier
Indicates whether a client secret is configured
Human-readable description
metadata: Optional[Metadata]Provider metadata
Provider metadata
Icon URL
protocols: Optional[Protocols]Protocol-specific configuration
Protocol-specific configuration
oauth2: Optional[ProtocolsOauth2]OAuth 2.0 protocol configuration
OAuth 2.0 protocol configuration
OIDC issuer URL used for discovery and token validation.
Custom query parameters appended to authorization redirect URLs. Use for non-standard providers (e.g. Google prompt=consent, access_type=offline).
Whether to include the resource parameter in authorization requests.
The resource parameter value to include in authorization requests. Defaults to "resource" when authorization_resource_enabled is true.
The query parameter name for scopes in authorization requests. Defaults to "scope". Slack v2 uses "user_scope".
The separator character for scope values. Defaults to " " (space). Slack v2 uses ",".
Dot-separated path to the access token in the token response body. Defaults to "access_token". Slack v2 uses "authed_user.access_token".
openid: Optional[ProtocolsOpenid]OpenID Connect protocol configuration
OpenID Connect protocol configuration
Name of the OIDC claim carrying the stable external id used to correlate logins with externally provisioned (SCIM) users. Defaults to "sub". Set to "oid" for Entra, whose pairwise "sub" differs from the SCIM externalId.
Additional OIDC scopes to request from this provider during authentication (e.g. "groups"). Merged with the default scopes (openid, profile, email).
When true, logging out of the zone propagates the logout to this provider's end_session_endpoint (RP-initiated logout). Defaults to false.
Name of a top-level string claim in this provider's ID Token to use as the user identifier on user creation. When not set, the user's Keycard ID is used.
type: Optional[Literal["external", "keycard-vault", "keycard-sts"]]
ID of the credential provider for this resource
Human-readable description
metadata: Optional[Metadata]Entity metadata
Entity metadata
Documentation URL
Icon URL
Scopes supported by the resource
List of resource IDs that, when accessed, make this dependency available. Only present when this resource is returned as a dependency.
Deprecateduser: Optional[User]An authenticated user entity
An authenticated user entity
Unique identifier of the user
Entity creation timestamp
Email address of the user
Whether the email address has been verified
Zone-scoped user identifier. Defaults to the user's Keycard ID. When the provider has user_identifier_claim configured, the value is set from that claim at user creation time.
Organization that owns this user
status: Literal["active", "disabled"]Status of the user. Disabled users cannot authenticate.
Status of the user. Disabled users cannot authenticate.
Entity update timestamp
Zone this user belongs to
Date when the user was last authenticated
credentials: Optional[List[Credential]]Authentication credentials for this user, each carrying its identity provider for federation credentials. Populated only when expand[]=credentials is set on the listing endpoint.
Authentication credentials for this user, each carrying its identity provider for federation credentials. Populated only when expand[]=credentials is set on the listing endpoint.
class CredentialIamUserCredentialFederation: …Federation credential: the user authenticates through an identity provider.
Federation credential: the user authenticates through an identity provider.
Entity creation timestamp
ID of the identity provider backing this credential. null when the source provider has been deleted.
Entity update timestamp
Issuer identifier of the identity provider.
provider: Optional[Provider]A Provider is a system that supplies access to Resources and allows actors (Users or Applications) to authenticate.
A Provider is a system that supplies access to Resources and allows actors (Users or Applications) to authenticate.
Unique identifier of the provider
Entity creation timestamp
User specified identifier, unique within the zone
Human-readable name
Organization that owns this provider
owner_type: Literal["platform", "customer"]Who owns this provider. Platform-owned providers cannot be modified via API.
Who owns this provider. Platform-owned providers cannot be modified via API.
URL-safe identifier, unique within the zone
Entity update timestamp
Zone this provider belongs to
OAuth 2.0 client identifier
Indicates whether a client secret is configured
Human-readable description
metadata: Optional[Metadata]Provider metadata
Provider metadata
Icon URL
protocols: Optional[Protocols]Protocol-specific configuration
Protocol-specific configuration
oauth2: Optional[ProtocolsOauth2]OAuth 2.0 protocol configuration
OAuth 2.0 protocol configuration
OIDC issuer URL used for discovery and token validation.
Custom query parameters appended to authorization redirect URLs. Use for non-standard providers (e.g. Google prompt=consent, access_type=offline).
Whether to include the resource parameter in authorization requests.
The resource parameter value to include in authorization requests. Defaults to "resource" when authorization_resource_enabled is true.
The query parameter name for scopes in authorization requests. Defaults to "scope". Slack v2 uses "user_scope".
The separator character for scope values. Defaults to " " (space). Slack v2 uses ",".
Dot-separated path to the access token in the token response body. Defaults to "access_token". Slack v2 uses "authed_user.access_token".
openid: Optional[ProtocolsOpenid]OpenID Connect protocol configuration
OpenID Connect protocol configuration
Name of the OIDC claim carrying the stable external id used to correlate logins with externally provisioned (SCIM) users. Defaults to "sub". Set to "oid" for Entra, whose pairwise "sub" differs from the SCIM externalId.
Additional OIDC scopes to request from this provider during authentication (e.g. "groups"). Merged with the default scopes (openid, profile, email).
When true, logging out of the zone propagates the logout to this provider's end_session_endpoint (RP-initiated logout). Defaults to false.
Name of a top-level string claim in this provider's ID Token to use as the user identifier on user creation. When not set, the user's Keycard ID is used.
type: Optional[Literal["external", "keycard-vault", "keycard-sts"]]
Subject identifier from the identity provider.
class CredentialIamUserCredentialPassword: …Password credential: the user authenticates with email and password. The email lives on the user.
Password credential: the user authenticates with email and password. The email lives on the user.
Entity creation timestamp
Entity update timestamp
Delegated-grant count for this user. Populated only when expand[]=grant_count is set on the listing endpoint.
groups: Optional[List[Group]]Groups this user belongs to within the zone. Populated only when expand[]=groups is set on the listing endpoint.
Groups this user belongs to within the zone. Populated only when expand[]=groups is set on the listing endpoint.
Unique identifier of the group
Zone-unique slug that policy rules match on.
Human-readable group name
Issuer identifier of the identity provider
Reference to the identity provider. This field is undefined when the source identity provider is deleted but the user is not deleted.
role_assignments: Optional[List[RoleAssignment]]Role grants for this user within the zone. Populated only when expand[]=role-assignments is set on the listing endpoint.
Role grants for this user within the zone. Populated only when expand[]=role-assignments is set on the listing endpoint.
ID of the assigned role
Role identifier: a lowercase slug (letters and digits separated by single hyphens or underscores), unique per owner type within a zone. Role identifiers surface in policy evaluation, so the slug restriction keeps them unambiguous in policy text.
role_owner_type: Literal["platform", "customer"]Owner type of the granted role. Disambiguates roles that share an identifier across owner types.
Owner type of the granted role. Disambiguates roles that share an identifier across owner types.
scope: Optional[RoleAssignmentScope]The resource this grant is scoped to, or null when the grant is unscoped (applies to the owning zone itself).
The resource this grant is scoped to, or null when the grant is unscoped (applies to the owning zone itself).
The ID of the scoped resource.
The kind of resource this grant is scoped to (e.g. zone).
source: Literal["user", "group"]The principal that holds this grant: user when assigned directly to the user, or group when inherited through group membership.
The principal that holds this grant: user when assigned directly to the user, or group when inherited through group membership.
ID of the group this grant is inherited from. Present only when source is group.
Session count for this user. Populated only when expand[]=session_count is set on the listing endpoint.
Subject identifier from the identity provider