Sessions
List sessions
Get session
Update session
ModelsExpand Collapse
type SessionUnion interface{…}An authenticated identity session. Sessions can be user sessions (representing end-user authentication) or application sessions (representing service-to-service authentication). User sessions support hierarchical relationships via parent_id, while application sessions are always standalone.
An authenticated identity session. Sessions can be user sessions (representing end-user authentication) or application sessions (representing service-to-service authentication). User sessions support hierarchical relationships via parent_id, while application sessions are always standalone.
type SessionUserSessionType struct{…}User session type-specific fields
User session type-specific fields
User ID
Session ID
Whether the session is currently active (deprecated - use status instead)
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
Entity creation timestamp
Number of resource dependencies
User specified identifier, unique within the zone
Human-readable name
Organization that owns this application
OwnerType ApplicationOwnerTypeWho 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
Entity metadata
Entity metadata
Documentation URL
Protocols ApplicationProtocolsoptionalProtocol-specific configuration
Protocol-specific configuration
Oauth2 ApplicationProtocolsOauth2optionalOAuth 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
Application ID that initiated this session
Date when the session was authenticated
Entity creation timestamp
Date when session expires
Issuer URL from IdP
Metadata SessionUserSessionTypeMetadataoptionalSession metadata
Session metadata
Name of the initiating application or user agent
Organization that owns this session
Parent session ID for hierarchical sessions (user sessions only). When null, this is a web session - a top-level session initiated directly by a user. When set, this is a child session derived from the parent, used for token refresh or delegation. Application sessions cannot have parents.
Provider ID
Session claims data (ID token claims for users, application claims for applications)
Status stringoptional
Subject claim from IdP
Entity update timestamp
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
Organization that owns this user
Entity update timestamp
Zone this user belongs to
Date when the user was last authenticated
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.
Subject identifier from the identity provider
A User Agent represents a user agent (browser, desktop app, CLI tool) that can initiate user sessions via OAuth 2.0 Dynamic Client Registration.
A User Agent represents a user agent (browser, desktop app, CLI tool) that can initiate user sessions via OAuth 2.0 Dynamic Client Registration.
Unique identifier of the user agent
Entity creation timestamp
User agent identifier (serves as OAuth client_id). Format: ua:{sha256_hash}
Human-readable name
Organization that owns this user agent
URL-safe identifier, unique within the zone
Entity update timestamp
Zone this user agent belongs to
User agent ID (browser/client) that initiated this session
Zone this session belongs to
type SessionApplicationSessionType struct{…}Application session type-specific fields
Application session type-specific fields
Application ID that initiated this session
Issuer URL from IdP
Provider ID
Subject claim from IdP
Session ID
Whether the session is currently active (deprecated - use status instead)
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
Entity creation timestamp
Number of resource dependencies
User specified identifier, unique within the zone
Human-readable name
Organization that owns this application
OwnerType ApplicationOwnerTypeWho 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
Entity metadata
Entity metadata
Documentation URL
Protocols ApplicationProtocolsoptionalProtocol-specific configuration
Protocol-specific configuration
Oauth2 ApplicationProtocolsOauth2optionalOAuth 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
Date when the session was authenticated
Entity creation timestamp
Date when session expires
Metadata SessionApplicationSessionTypeMetadataoptionalSession metadata
Session metadata
Name of the initiating application or user agent
Organization that owns this session
Session claims data (ID token claims for users, application claims for applications)
Status stringoptional
Entity update timestamp
Zone this session belongs to