Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Identity and Access Management API, gRPC: ServiceAccountService.Create

Written by
Updated at October 17, 2024

Creates a service account in the specified folder.

gRPC request

rpc Create (CreateServiceAccountRequest) returns (operation.Operation)

CreateServiceAccountRequest

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "string"
}

Field

Description

folderId

string

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

name

string

Required field. Name of the service account.
The name must be unique within the cloud.

description

string

Description of the service account.

labels

string

Resource labels as key:value pairs.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "serviceAccountId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folderId": "string",
    "createdAt": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "string",
    "lastAuthenticatedAt": "google.protobuf.Timestamp"
  }
  // 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

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

CreateServiceAccountMetadata

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

ServiceAccount

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.

CreateServiceAccountMetadata

Field

Description

serviceAccountId

string

ID of the service account that is being created.

ServiceAccount

A ServiceAccount resource. For more information, see Service accounts.

Field

Description

id

string

ID of the service account.

folderId

string

ID of the folder that the service account belongs to.

createdAt

google.protobuf.Timestamp

Creation timestamp.

name

string

Name of the service account.
The name is unique within the cloud. 3-63 characters long.

description

string

Description of the service account. 0-256 characters long.

labels

string

Resource labels as key:value pairs. Maximum of 64 per resource.

lastAuthenticatedAt

google.protobuf.Timestamp

Timestamp for the last authentication of this service account.
Previous
List
Next
Update