Auth

Methods

TypeScript
Python
Rust

List OAuth scopes

TypeScript

photon.auth.listOauthScopes(input?: ListOauthScopesInput, options?: RequestOptions): Promise<ListOauthScopesOutput>

GET /v1/auth/oauth/scopesGet organization connection status

TypeScript

photon.auth.getOrganizationConnectionStatus(input: GetOrganizationConnectionStatusInput, options?: RequestOptions): Promise<GetOrganizationConnectionStatusOutput>

GET /v1/auth/organizations/{orgId}/connection-statusGet organization SSO configuration

TypeScript

photon.auth.getOrganizationSsoConfiguration(input: GetOrganizationSsoConfigurationInput, options?: RequestOptions): Promise<GetOrganizationSsoConfigurationOutput>

GET /v1/auth/organizations/{orgId}/ssoSign in with invitation SSO

TypeScript

photon.auth.beginInvitationSso(input: BeginInvitationSsoInput, options?: RequestOptions): Promise<BeginInvitationSsoOutput>

POST /v1/auth/organizations/{orgId}/sso/invitationSign in with organization SSO

TypeScript

photon.auth.beginOrganizationAuthentication(input: BeginOrganizationAuthenticationInput, options?: RequestOptions): Promise<BeginOrganizationAuthenticationOutput>

POST /v1/auth/organizations/{orgId}/sso/authenticateSign in to close organization

TypeScript

photon.auth.beginOrganizationClosureAuthentication(input: BeginOrganizationClosureAuthenticationInput, options?: RequestOptions): Promise<BeginOrganizationClosureAuthenticationOutput>

POST /v1/auth/organizations/{orgId}/sso/closure-authenticateBegin organization SSO admission

TypeScript

photon.auth.beginOrganizationSsoAdmission(input: BeginOrganizationSsoAdmissionInput, options?: RequestOptions): Promise<BeginOrganizationSsoAdmissionOutput>

POST /v1/auth/organizations/{orgId}/sso/admissionCreate organization setup portal link

TypeScript

photon.auth.createOrganizationSsoPortalLink(input: CreateOrganizationSsoPortalLinkInput, options?: RequestOptions): Promise<CreateOrganizationSsoPortalLinkOutput>

POST /v1/auth/organizations/{orgId}/sso/portalDisable organization SSO

TypeScript

photon.auth.disableOrganizationSso(input: DisableOrganizationSsoInput, options?: RequestOptions): Promise<DisableOrganizationSsoOutput>

POST /v1/auth/organizations/{orgId}/sso/disableRefresh organization SSO connection

TypeScript

photon.auth.refreshOrganizationSsoConnection(input: RefreshOrganizationSsoConnectionInput, options?: RequestOptions): Promise<RefreshOrganizationSsoConnectionOutput>

POST /v1/auth/organizations/{orgId}/sso/refreshRetry organization connection sync

TypeScript

photon.auth.retryOrganizationConnectionSync(input: RetryOrganizationConnectionSyncInput, options?: RequestOptions): Promise<RetryOrganizationConnectionSyncOutput>

POST /v1/auth/organizations/{orgId}/connection-sync/retryStart company sign-in

TypeScript

photon.auth.startEnterpriseLogin(input: StartEnterpriseLoginInput, options?: RequestOptions): Promise<StartEnterpriseLoginOutput>

POST /v1/auth/login/enrollmentUpdate organization SSO policy

TypeScript

photon.auth.updateOrganizationSsoPolicy(input: UpdateOrganizationSsoPolicyInput, options?: RequestOptions): Promise<UpdateOrganizationSsoPolicyOutput>

PATCH /v1/auth/organizations/{orgId}/sso

List OAuth scopes

Python

photon.auth.list_oauth_scopes(input: ListOauthScopesInput | None = None) -> models.ListOauthScopesResponse

GET /v1/auth/oauth/scopesGet organization connection status

Python

photon.auth.get_organization_connection_status(input: GetOrganizationConnectionStatusInput) -> models.OrganizationConnectionStatus

GET /v1/auth/organizations/{orgId}/connection-statusGet organization SSO configuration

Python

photon.auth.get_organization_sso_configuration(input: GetOrganizationSsoConfigurationInput) -> models.OrganizationSsoConfiguration

GET /v1/auth/organizations/{orgId}/ssoSign in with invitation SSO

Python

photon.auth.begin_invitation_sso(input: BeginInvitationSsoInput) -> models.OrganizationAuthenticationRedirect

POST /v1/auth/organizations/{orgId}/sso/invitationSign in with organization SSO

Python

photon.auth.begin_organization_authentication(input: BeginOrganizationAuthenticationInput) -> models.OrganizationAuthenticationRedirect

POST /v1/auth/organizations/{orgId}/sso/authenticateSign in to close organization

Python

photon.auth.begin_organization_closure_authentication(input: BeginOrganizationClosureAuthenticationInput) -> models.OrganizationAuthenticationRedirect

POST /v1/auth/organizations/{orgId}/sso/closure-authenticateBegin organization SSO admission

Python

photon.auth.begin_organization_sso_admission(input: BeginOrganizationSsoAdmissionInput) -> models.OrganizationAuthenticationRedirect

POST /v1/auth/organizations/{orgId}/sso/admissionCreate organization setup portal link

Python

photon.auth.create_organization_sso_portal_link(input: CreateOrganizationSsoPortalLinkInput) -> models.CreateOrganizationSsoPortalLinkResponse

POST /v1/auth/organizations/{orgId}/sso/portalDisable organization SSO

Python

photon.auth.disable_organization_sso(input: DisableOrganizationSsoInput) -> models.OrganizationSsoConfiguration

POST /v1/auth/organizations/{orgId}/sso/disableRefresh organization SSO connection

Python

photon.auth.refresh_organization_sso_connection(input: RefreshOrganizationSsoConnectionInput) -> models.OrganizationSsoConfiguration

POST /v1/auth/organizations/{orgId}/sso/refreshRetry organization connection sync

Python

photon.auth.retry_organization_connection_sync(input: RetryOrganizationConnectionSyncInput) -> models.OrganizationConnectionStatus

POST /v1/auth/organizations/{orgId}/connection-sync/retryStart company sign-in

Python

photon.auth.start_enterprise_login(input: StartEnterpriseLoginInput) -> models.StartEnterpriseLoginResponse

POST /v1/auth/login/enrollmentUpdate organization SSO policy

Python

photon.auth.update_organization_sso_policy(input: UpdateOrganizationSsoPolicyInput) -> models.OrganizationSsoConfiguration

PATCH /v1/auth/organizations/{orgId}/sso

List OAuth scopes

Rust

client.list_oauth_scopes().await -> Result<ResponseValue<types::ListOauthScopesResponse>, Error<ListOauthScopesError>>

GET /v1/auth/oauth/scopesGet organization connection status

Rust

client.get_organization_connection_status(org_id: String).await -> Result<ResponseValue<types::OrganizationConnectionStatus>, Error<GetOrganizationConnectionStatusError>>

GET /v1/auth/organizations/{orgId}/connection-statusGet organization SSO configuration

Rust

client.get_organization_sso_configuration(org_id: String).await -> Result<ResponseValue<types::OrganizationSsoConfiguration>, Error<GetOrganizationSsoConfigurationError>>

GET /v1/auth/organizations/{orgId}/ssoSign in with invitation SSO

Rust

client.begin_invitation_sso(org_id: String, body: &types::BeginInvitationSsoRequest).await -> Result<ResponseValue<types::OrganizationAuthenticationRedirect>, Error<BeginInvitationSsoError>>

POST /v1/auth/organizations/{orgId}/sso/invitationSign in with organization SSO

Rust

client.begin_organization_authentication(org_id: String, body: &types::OrganizationAuthenticationRequest).await -> Result<ResponseValue<types::OrganizationAuthenticationRedirect>, Error<BeginOrganizationAuthenticationError>>

POST /v1/auth/organizations/{orgId}/sso/authenticateSign in to close organization

Rust

client.begin_organization_closure_authentication(org_id: String, body: &types::OrganizationAuthenticationRequest).await -> Result<ResponseValue<types::OrganizationAuthenticationRedirect>, Error<BeginOrganizationClosureAuthenticationError>>

POST /v1/auth/organizations/{orgId}/sso/closure-authenticateBegin organization SSO admission

Rust

client.begin_organization_sso_admission(org_id: String, body: &types::OrganizationAuthenticationRequest).await -> Result<ResponseValue<types::OrganizationAuthenticationRedirect>, Error<BeginOrganizationSsoAdmissionError>>

POST /v1/auth/organizations/{orgId}/sso/admissionCreate organization setup portal link

Rust

client.create_organization_sso_portal_link(org_id: String, body: &types::CreateOrganizationSsoPortalLinkRequest).await -> Result<ResponseValue<types::CreateOrganizationSsoPortalLinkResponse>, Error<CreateOrganizationSsoPortalLinkError>>

POST /v1/auth/organizations/{orgId}/sso/portalDisable organization SSO

Rust

client.disable_organization_sso(idempotency_key: String, org_id: String, body: &types::DisableOrganizationSsoRequest).await -> Result<ResponseValue<types::OrganizationSsoConfiguration>, Error<DisableOrganizationSsoError>>

POST /v1/auth/organizations/{orgId}/sso/disableRefresh organization SSO connection

Rust

client.refresh_organization_sso_connection(org_id: String).await -> Result<ResponseValue<types::OrganizationSsoConfiguration>, Error<RefreshOrganizationSsoConnectionError>>

POST /v1/auth/organizations/{orgId}/sso/refreshRetry organization connection sync

Rust

client.retry_organization_connection_sync(org_id: String).await -> Result<ResponseValue<types::OrganizationConnectionStatus>, Error<RetryOrganizationConnectionSyncError>>

POST /v1/auth/organizations/{orgId}/connection-sync/retryStart company sign-in

Rust

client.start_enterprise_login(body: &types::StartEnterpriseLoginRequest).await -> Result<ResponseValue<types::StartEnterpriseLoginResponse>, Error<StartEnterpriseLoginError>>

POST /v1/auth/login/enrollmentUpdate organization SSO policy

Rust

client.update_organization_sso_policy(org_id: String, body: &types::UpdateOrganizationSsoPolicyRequest).await -> Result<ResponseValue<types::OrganizationSsoConfiguration>, Error<UpdateOrganizationSsoPolicyError>>

PATCH /v1/auth/organizations/{orgId}/sso

Resources

Device

Models

ListOauthScopesResponse

array of string

required

Business permissions an OAuth application can be configured with. Client creation and scope updates accept only these values. OIDC protocol scopes (openid, profile, email, offline_access) are not included.

OrganizationConnectionStatus

OrganizationConnectionStatusMembership

required

OrganizationConnectionStatusOrganization

required

string

required

boolean

required

OrganizationSsoConfiguration

string (date-time) | null

required

string

required

OrganizationSsoConfigurationConnectionState

required

string

boolean

required

array of OrganizationSsoDomain

string

required

OrganizationSsoConfigurationPolicySyncStatus

required

boolean

required

boolean

required

string

required

OrganizationAuthenticationRedirect

string

required

CreateOrganizationSsoPortalLinkResponse

string

required

StartEnterpriseLoginResponse

string (uri)

required

Get started

Guides

Reference

SDK reference

Methods

Resources

Models

ListOauthScopesResponse

OrganizationConnectionStatus

OrganizationSsoConfiguration

OrganizationAuthenticationRedirect

CreateOrganizationSsoPortalLinkResponse

StartEnterpriseLoginResponse

​Methods

​Resources

​Models

​ListOauthScopesResponse

​OrganizationConnectionStatus

​OrganizationSsoConfiguration

​OrganizationAuthenticationRedirect

​CreateOrganizationSsoPortalLinkResponse

​StartEnterpriseLoginResponse

Methods

Resources

Models

ListOauthScopesResponse

OrganizationConnectionStatus

OrganizationSsoConfiguration

OrganizationAuthenticationRedirect

CreateOrganizationSsoPortalLinkResponse

StartEnterpriseLoginResponse