Skip to main content

Get

Returns the specified OIDC workload identity federation.

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

import { cloudApi, serviceClients, Session } from "@yandex-cloud/nodejs-sdk";

const GetFederationRequest =
cloudApi.iam.workload_oidc_federation_service.GetFederationRequest;

(async () => {
const authToken = process.env["YC_OAUTH_TOKEN"];
const session = new Session({ oauthToken: authToken });
const client = session.client(serviceClients.FederationServiceClient);

const result = await client.get(
GetFederationRequest.fromPartial({
federationId: "federationId",
})
);
console.log(result);
})();

GetFederationRequest

federationId : string

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

Federation

A OIDC workload identity federation.

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

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 : google.protobuf.Timestamp

Creation timestamp.