Sign in
SSO

Create

Create an SSO application for an application in your catalog. The entitlement that governs sign-in is created alongside it. OIDC creation also server-mints the required initial client and returns its secret once when the client is confidential. SAML creation has no OAuth-client step.

post/api/v1/apps/{app_id}/sso/applications

Path parameters

app_idstring required

The application in your catalog to attach this sign-in configuration to.

Request body

assertionLifetimestring duration nullable
descriptionstring

Description of the SSO application.

displayNamestring required

Display name for the SSO application.

sectorIdstring

The pairwise sector this application belongs to. Empty means the application is its own sector. Immutable after creation.

subjectType'SSO_SUBJECT_TYPE_UNSPECIFIED' | 'SSO_SUBJECT_TYPE_PAIRWISE' | 'SSO_SUBJECT_TYPE_PUBLIC' | 'SSO_SUBJECT_TYPE_COMPATIBILITY'

How the user's identifier reaches this application. Leave unset to use the tenant default.

Response

SSOApplicationServiceCreateResponse returns the created SSO application.

clientSecretstring

Confidential-client secret returned once. Empty for SAML and public OIDC clients. C1 stores only its hash.

Changes

Changed in 1 of the 33 revisions of this API.1