USusememos
IdentityProviderService

POST /api/identity-providers

Changed on

CreateIdentityProvider creates an identity provider. Requires the admin role. Fails with FAILED_PRECONDITION when the ID belongs to a provider configured by the deployment.

Request

  • The document declares no server URL.
  • Auth
    none declared

Query parameters

identityProviderIdstring

Optional. The ID to use for the identity provider, which becomes the final component of the resource name. If empty, the server generates one. Format: ^a-zA-Z0-9?$

Request body

namestring

Identifier. The resource name of the identity provider. Format: identity-providers/{idp}

type'TYPE_UNSPECIFIED' | 'OAUTH2' enum required

Required. The type of the identity provider.

titlestring required

Required. The display title of the identity provider.

identifierFilterstring

Optional. A regular expression the user identifier must match to sign in. Empty allows every identifier.

Response

OK

namestring

Identifier. The resource name of the identity provider. Format: identity-providers/{idp}

type'TYPE_UNSPECIFIED' | 'OAUTH2' enum required

Required. The type of the identity provider.

titlestring required

Required. The display title of the identity provider.

identifierFilterstring

Optional. A regular expression the user identifier must match to sign in. Empty allows every identifier.

Changes