Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Identity and Access Management
  • Secure use of Yandex Cloud
  • Access management
  • Pricing policy
  • Role reference
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
        • List
        • Get
        • Create
        • Update
        • Delete
        • ListOperations
        • ListScopes
  • Monitoring metrics
  • Audit Trails events
  • Release notes

In this article:

  • gRPC request
  • CreateApiKeyRequest
  • CreateApiKeyResponse
  • ApiKey
  1. API reference
  2. gRPC
  3. ApiKey
  4. Create

Identity and Access Management API, gRPC: ApiKeyService.Create

Written by
Yandex Cloud
Updated at March 26, 2025
  • gRPC request
  • CreateApiKeyRequest
  • CreateApiKeyResponse
  • ApiKey

Creates an API key for the specified service account.

gRPC requestgRPC request

rpc Create (CreateApiKeyRequest) returns (CreateApiKeyResponse)

CreateApiKeyRequestCreateApiKeyRequest

{
  "service_account_id": "string",
  "description": "string",
  "scope": "string",
  "scopes": [
    "string"
  ],
  "expires_at": "google.protobuf.Timestamp"
}

Field

Description

service_account_id

string

ID of the service account to create an API key for.
To get the service account ID, use a yandex.cloud.iam.v1.ServiceAccountService.List request.
If not specified, it defaults to the subject that made the request.

description

string

Description of the API key.

scopes[]

string

Scopes of the API key.

expires_at

google.protobuf.Timestamp

API key expiration timestamp, if not specified, then the API key doesn't expire

CreateApiKeyResponseCreateApiKeyResponse

{
  "api_key": {
    "id": "string",
    "service_account_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "description": "string",
    "last_used_at": "google.protobuf.Timestamp",
    "scope": "string",
    "scopes": [
      "string"
    ],
    "expires_at": "google.protobuf.Timestamp"
  },
  "secret": "string"
}

Field

Description

api_key

ApiKey

ApiKey resource.

secret

string

Secret part of the API key. This secret key you may use in the requests for authentication.

ApiKeyApiKey

An ApiKey resource. For more information, see Api-Key.

Field

Description

id

string

ID of the API Key.

service_account_id

string

ID of the service account that the API key belongs to.

created_at

google.protobuf.Timestamp

Creation timestamp.

description

string

Description of the API key. 0-256 characters long.

last_used_at

google.protobuf.Timestamp

Timestamp for the last authentication using this API key.

scopes[]

string

Scopes of the API key. 0-256 characters long.

expires_at

google.protobuf.Timestamp

API key expiration timestamp.

Was the article helpful?

Previous
Get
Next
Update
© 2025 Direct Cursus Technology L.L.C.