Contact UsGet started

Federation, REST: Federation.List

Written by
Updated at November 7, 2024

Retrieves the list of OIDC workload identity federations in the specified folder.

HTTP request

GET https://iam.api.cloud.yandex.net/iam/v1/workload/oidc/federations

Query parameters

Field

Description

folderId

string

Required field. ID of the folder to list OIDC workload identity federations in.
To get the folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request.

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is larger than pageSize,
the service returns a ListFederationsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Default value: 100

pageToken

string

Page token. To get the next page of results, set pageToken
to the ListFederationsResponse.nextPageToken
returned by a previous list request.

Response

HTTP Code: 200 - OK

{
  "federations": [
    {
      "id": "string",
      "name": "string",
      "folderId": "string",
      "description": "string",
      "enabled": "boolean",
      "audiences": [
        "string"
      ],
      "issuer": "string",
      "jwksUrl": "string",
      "labels": "string",
      "createdAt": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

federations[]

Federation

List of OIDC workload identity federations.

nextPageToken

string

This token allows you to get the next page of results for list requests. If the number of results
is larger than ListFederationsRequest.pageSize, use
the nextPageToken as the value
for the ListFederationsRequest.pageToken query parameter
in the next list request. Each subsequent list request will have its own
nextPageToken to continue paging through the results.

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
The name is unique within the folder. 3-63 characters long.

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.
False - the OIDC workload identity federation is disabled and cannot 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 key:value pairs

createdAt

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
Previous
Get
Next
Create