Contact UsGet started

Workload Identity, REST: FederatedCredential.List

Written by
Updated at November 26, 2024

Retrieves the list of federated credentials for the specified service account.

HTTP request

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

Query parameters

Field

Description

serviceAccountId

string

Required field. ID of the service account to list federated credentials for.
To get the the service account ID make a yandex.cloud.iam.v1.ServiceAccountService.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 ListFederatedCredentialsResponse.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 ListFederatedCredentialsResponse.nextPageToken
returned by a previous list request.

Response

HTTP Code: 200 - OK

{
  "federatedCredentials": [
    {
      "id": "string",
      "serviceAccountId": "string",
      "federationId": "string",
      "externalSubjectId": "string",
      "createdAt": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

federatedCredentials[]

FederatedCredential

List of federated credentials.

nextPageToken

string

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

FederatedCredential

A federated credential.

Field

Description

id

string

Id of the federated credential.

serviceAccountId

string

Id of the service account that the federated credential belongs to.

federationId

string

ID of the workload identity federation which is used for authentication.

externalSubjectId

string

Id of the external subject.

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