Contact UsGet started

Cloud Organization API, gRPC: UserSshKeyService.Create

Written by
Updated at November 26, 2024

gRPC request

rpc Create (CreateUserSshKeyRequest) returns (operation.Operation)

CreateUserSshKeyRequest

{
  "organization_id": "string",
  "subject_id": "string",
  "name": "string",
  "data": "string",
  "expires_at": "google.protobuf.Timestamp"
}

Field

Description

organization_id

string

Required field.

subject_id

string

Required field.

name

string

data

string

Required field.

expires_at

google.protobuf.Timestamp

operation.Operation

{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "user_ssh_key_id": "string",
    "organization_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "subject_id": "string",
    "data": "string",
    "name": "string",
    "fingerprint": "string",
    "organization_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "expires_at": "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.

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

CreateUserSshKeyMetadata

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

UserSshKey

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.

CreateUserSshKeyMetadata

Field

Description

user_ssh_key_id

string

organization_id

string

UserSshKey

Field

Description

id

string

subject_id

string

data

string

name

string

fingerprint

string

organization_id

string

created_at

google.protobuf.Timestamp

expires_at

google.protobuf.Timestamp

Used for temporary keys, if empty the key doesn't expire
Previous
List
Next
Update