Create

Creates an OIDC workload identity federation in the specified folder.

TypeScript

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

const CreateFederationRequest =
  cloudApi.iam.workload_oidc_federation_service.CreateFederationRequest;
const Federation = cloudApi.iam.workload_oidc_federation.Federation;

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

  const operation = await client.create(
    CreateFederationRequest.fromPartial({
      folderId: "folderId",
      name: "name",
      // description: "description",
      // disabled: true,
      // audiences: ["audiences"],
      issuer: "issuer",
      jwksUrl: "jwksUrl",
      // labels: {"key": "labels"}
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof Federation>(finishedOp.response);
    console.log(result);
  }
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.iam.v1.workload.oidc.federation_service_pb2 import CreateFederationMetadata
from yandex.cloud.iam.v1.workload.oidc.federation_service_pb2 import CreateFederationRequest
from yandex.cloud.iam.v1.workload.oidc.federation_pb2 import Federation
from yandex.cloud.iam.v1.workload.oidc.federation_service_pb2_grpc import FederationServiceStub

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(FederationServiceStub)
operation = service.Create(
    CreateFederationRequest(
        folder_id="folderId",
        name="name",
        # description = "description",
        # disabled = true,
        # audiences = ["audiences"],
        issuer="issuer",
        jwks_url="jwksUrl",
        # labels = {"key": "labels"}
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=Federation,
    meta_type=CreateFederationMetadata,
)
print(operation_result)

CreateFederationRequest

folderId : string

ID of the folder to create an OIDC workload identity federation in. To get the folder ID, make a yandex.cloud.resourcemanager.v1.FolderService.List request.

name : string

Name of the OIDC workload identity federation. The name must be unique within the folder.

description : string

Description of the OIDC workload identity federation.

disabled : bool

True - the OIDC workload identity federation is disabled and cannot be used for authentication. False - 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 : string

Resource labels as key:value pairs

Operation

An Operation resource. For more information, see Operation.

id : string

ID of the operation.

description : string

Description of the operation. 0-256 characters long.

createdAt : google.protobuf.Timestamp

Creation timestamp.

createdBy : string

ID of the user or service account who initiated the operation.

modifiedAt : google.protobuf.Timestamp

The time when the Operation resource was last modified.

done : bool

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadata : google.protobuf.Any

Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.

One of result

The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true, exactly one of error or response is set.

• error : google.rpc.Status

  The error result of the operation in case of failure or cancellation.

• response : google.protobuf.Any

  The normal response of the operation in case of success.

  If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any.

---