Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Identity and Access Management
  • Secure use of Yandex Cloud
  • Access management
  • Pricing policy
  • Role reference
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
          • Overview
            • Overview
            • Get
            • List
            • Create
            • Update
            • Delete
            • ListAccessBindings
            • SetAccessBindings
            • UpdateAccessBindings
  • Monitoring metrics
  • Audit Trails events
  • Release notes

In this article:

  • HTTP request
  • Path parameters
  • Response
  1. API reference
  2. REST
  3. Workload Identity
  4. Federation
  5. Federation
  6. Get

Federation, REST: Federation.Get

Written by
Yandex Cloud
Updated at April 24, 2025
  • HTTP request
  • Path parameters
  • Response

Returns the specified OIDC workload identity federation.

To get the list of available OIDC workload identity federation, make a List request.

HTTP requestHTTP request

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

Path parametersPath parameters

Field

Description

federationId

string

Required field. ID of the OIDC workload identity federation to return.
To get the OIDC workload identity federation ID, make a FederationService.List request.

ResponseResponse

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
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

object (map<string, 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).

Was the article helpful?

Previous
Overview
Next
List
© 2025 Direct Cursus Technology L.L.C.