DocumentationAPI reference
Rust · 0.1.0
Update Identity Provider
PATCH /api/v1/identity-providers/{identity-provider}
IdentityProviderService · IdentityProviderService_UpdateIdentityProvider
Access
Requires an instance administrator. A normal authenticated account cannot perform this operation.
Supported changes and secret handling
A nonempty mask is required. Supported changes are title, identifier_filter and config; other paths are ignored by this implementation. When replacing OAuth config, an empty clientSecret preserves the previously stored secret. Returned objects omit clientSecret, so do not infer that a blank read means the configured secret is absent.
Request
UpdateIdentityProvider updates an identity provider.
/api/v1/identity-providers/{identity-provider}Parameters
| Name / location | Type / requirement | Description |
|---|---|---|
identity-providerpath | string Required | The identity-provider id. |
updateMaskquery | string (field-mask) Required (contract description) | Required. The update mask applies to the resource. Only the top level fields of IdentityProvider are supported. |
Request body
Required
application/json · IdentityProvider
Responses
200 · OK
application/json · IdentityProvider
default · Default error response
application/json · Status
Complete operation definition
All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.
Open JSON definition
{
"tags": [
"IdentityProviderService"
],
"description": "UpdateIdentityProvider updates an identity provider.",
"operationId": "IdentityProviderService_UpdateIdentityProvider",
"parameters": [
{
"name": "identity-provider",
"in": "path",
"description": "The identity-provider id.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "updateMask",
"in": "query",
"description": "Required. The update mask applies to the resource. Only the top level fields of\n IdentityProvider are supported.",
"schema": {
"type": "string",
"format": "field-mask"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityProvider"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityProvider"
}
}
}
},
"default": {
"description": "Default error response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Status"
}
}
}
}
}
}