Memos unofficial
PATCH/api/v1/identity-providers/{identity-provider}

Update an identity provider

Updates an identity provider using the supplied resource fields and update mask. Include type, title, and config in the request body, and use updateMask to select the top-level fields to update. Only top-level fields of the identity provider are supported by the mask.

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

2 parameters · 5 body fields
identity-providerstringrequired
The ID of the identity provider to update.
updateMaskstringoptional
Field mask selecting the identity provider fields to update. Only top-level fields are supported.

Identity provider fields for the update. 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 updated 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 in the request body, and type must be TYPE_UNSPECIFIED or OAUTH2. The updateMask query parameter selects fields to update and supports only top-level identity provider fields.