Memos unofficial
POST/api/v1/identity-providers

Create an identity provider

Creates an identity provider for the instance. Supply type, title, and config; use identityProviderId to choose the resource ID, or omit it to have one generated. The provider type must be TYPE_UNSPECIFIED or OAUTH2.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 5 body fields
identityProviderIdstringoptional
ID to use as the final component of the identity provider's resource name. Must match `^[a-zA-Z0-9]([a-zA-Z0-9-]{0,34}[a-zA-Z0-9])?$`; a generated ID is used when omitted.

Identity provider details. Supply type, title, and config.

namestringoptional
The resource name of the identity provider. Format: identity-providers/{idp}
typestringrequired
Required. The type of the identity provider.
Allowed:TYPE_UNSPECIFIEDOAUTH2
titlestringrequired
Required. The display title of the identity provider.
identifierFilterstringoptional
Optional. Filter applied to user identifiers.
configobjectrequired
Required. Configuration for the identity provider.

2 status codes
200Returns the created identity provider, including its resource name, type, title, and configuration.
namestringoptional
The resource name of the identity provider. Format: identity-providers/{idp}
typestringrequired
Required. The type of the identity provider.
Allowed:TYPE_UNSPECIFIEDOAUTH2
titlestringrequired
Required. The display title of the identity provider.
identifierFilterstringoptional
Optional. Filter applied to user identifiers.
configobjectrequired
Required. Configuration for the identity provider.
defaultReturns a standard error object containing an error code, developer-facing message, and optional details.
codeintegeroptional
The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
messagestringoptional
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
detailsarray<object>optional
A list of messages that carry the error details. There is a common set of message types for APIs to use.

Error handling

type, title, and config are required, and type must be TYPE_UNSPECIFIED or OAUTH2. If supplied, identityProviderId must match the pattern ^[a-zA-Z0-9]([a-zA-Z0-9-]{0,34}[a-zA-Z0-9])?$.