Federation, REST: Federation.Get
Returns the specified OIDC workload identity federation.
To get the list of available OIDC workload identity federation, make a List request.
HTTP request
GET 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 return. The maximum string length in characters is 50. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"name": "string",
"folderId": "string",
"description": "string",
"enabled": "boolean",
"audiences": [
"string"
],
"issuer": "string",
"jwksUrl": "string",
"labels": "object",
"createdAt": "string"
}
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 |
object (map<string, string>) Resource labels as |
|
createdAt |
string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |