Identity and Access Management API, gRPC: OAuthClientService.Create

Field

Description

name

string

Required field. Name of the oauth client.
The name must be unique within folder.

Value must match the regular expression [a-z]([-a-z0-9]{0,61}[a-z0-9])?.

redirect_uris[]

string

List of redirect uries allowed for the oauth client.

The maximum string length in characters for each value is 1000. The maximum number of elements is 1000.

scopes[]

string

List of oauth scopes requested by the oauth client.

The maximum string length in characters for each value is 255. Each value must match the regular expression [!#-\[\]-~]+. The maximum number of elements is 1000.

folder_id

string

Required field. ID of the folder to create an oauth client in.
To get the folder ID, use a yandex.cloud.resourcemanager.v1.FolderService.List request.

The maximum string length in characters is 255.

authentication_methods[]

string

List of authentication methods allowed for the oauth client.

The maximum string length in characters for each value is 255. The maximum number of elements is 1000.

post_logout_redirect_uris[]

string

List of URIs to which users can be redirected after signing out of the oauth client.

The maximum string length in characters for each value is 1000. The maximum number of elements is 1000.

profile_id

string

ID of the profile that defines the set of allowed settings for the oauth client.

The maximum string length in characters is 32.

pkce_required

bool

Whether PKCE (Proof Key for Code Exchange) is required for the oauth client during the authorization code flow.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

created_at

google.protobuf.Timestamp

Creation timestamp.

created_by

string

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

modified_at

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.

error

google.rpc.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

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.

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.