USusememos
IdentityProviderService

PATCH /api/identity-providers/{identity-provider}

Changed on

UpdateIdentityProvider updates an identity provider. Requires the admin role. Providers configured by the deployment cannot be updated.

Request

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

Path parameters

identity-providerstring required

The identity-provider id.

Query parameters

updateMaskstring field-mask

Required. The fields to update. Supported paths: title, identifier_filter, config; other paths are ignored. An empty OAuth2 client secret in config keeps the stored secret.

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