Identity and Access Management Workload Identity API, REST: Federation.Update
Updates the specified OIDC workload identity federation.
HTTP request
PATCH https://iam.api.cloud.yandex.net/iam/v1/workload/oidc/federations/{federationId}
Path parameters
Field |
Description |
federationId |
string Required field. ID of the OIDC workload identity federation to update. |
Body parameters
{
"updateMask": "string",
"name": "string",
"description": "string",
"disabled": "boolean",
"audiences": [
"string"
],
"jwksUrl": "string",
"labels": "string"
}
Field |
Description |
updateMask |
string (field-mask) A comma-separated names off ALL fields to be updated. If |
name |
string Name of the OIDC workload identity federation. |
description |
string Description of the OIDC workload identity federation. |
disabled |
boolean True - the OIDC workload identity federation is disabled and cannot be used for authentication. |
audiences[] |
string List of trusted values for aud claim. |
jwksUrl |
string URL reference to trusted keys in format of JSON Web Key Set. |
labels |
string Resource labels as |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"federationId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"id": "string",
"name": "string",
"folderId": "string",
"description": "string",
"enabled": "boolean",
"audiences": [
"string"
],
"issuer": "string",
"jwksUrl": "string",
"labels": "string",
"createdAt": "string"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
UpdateFederationMetadata
Field |
Description |
federationId |
string ID of the OIDC workload identity federation that is being updated. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |
Federation
A OIDC workload identity federation.
Field |
Description |
id |
string Id of the OIDC workload identity federation. |
name |
string Name of the OIDC workload identity federation |
folderId |
string ID of the folder that the OIDC workload identity federation belongs to. |
description |
string Description of the service account. 0-256 characters long. |
enabled |
boolean True - the OIDC workload identity federation is enabled and can be used for authentication. |
audiences[] |
string List of trusted values for aud claim. |
issuer |
string URL of the external IdP server to be used for authentication. |
jwksUrl |
string URL reference to trusted keys in format of JSON Web Key Set. |
labels |
string Resource labels as |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |