Federation, REST: Federation.Create

Статья создана

Обновлена 17 декабря 2024 г.

HTTP request
Body parameters
Response
CreateFederationMetadata
Status
Federation

Creates an OIDC workload identity federation in the specified folder.

HTTP request

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

Body parameters

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "disabled": "boolean",
  "audiences": [
    "string"
  ],
  "issuer": "string",
  "jwksUrl": "string",
  "labels": "object"
}

Field	Description
folderId	string Required field. 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 Required field. 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	boolean 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 Required field. URL of the external IdP server to be used for authentication.
jwksUrl	string Required field. URL reference to trusted keys in format of JSON Web Key Set.
labels	object (map<string, string>) Resource labels as `key:value` pairs

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "federationId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "name": "string",
    "folderId": "string",
    "description": "string",
    "enabled": "boolean",
    "audiences": [
      "string"
    ],
    "issuer": "string",
    "jwksUrl": "string",
    "labels": "object",
    "createdAt": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
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).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. 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).
done	boolean 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	CreateFederationMetadata 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.
error	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. 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.
response	Federation 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. Includes only one of the fields `error`, `response`. 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.

CreateFederationMetadata

Field

Description

federationId

string

ID of the OIDC workload identity federation that is being created.

Status

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

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

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

Federation, REST: Federation.Create

HTTP requestHTTP request

Body parametersBody parameters

ResponseResponse

CreateFederationMetadataCreateFederationMetadata

StatusStatus

FederationFederation