Cloud Organization API, gRPC: UserSshKeyService
Статья создана
Обновлена 12 января 2024 г.
Call | Description |
---|---|
Get | |
List | |
Create | |
Update | |
Delete |
Calls UserSshKeyService
Get
rpc Get (GetUserSshKeyRequest) returns (UserSshKey)
GetUserSshKeyRequest
Field | Description |
---|---|
user_ssh_key_id | string Required. The maximum string length in characters is 50. |
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 |
List
rpc List (ListUserSshKeysRequest) returns (ListUserSshKeysResponse)
ListUserSshKeysRequest
Field | Description |
---|---|
organization_id | string Required. The maximum string length in characters is 50. |
subject_id | string The maximum string length in characters is 50. |
page_size | int64 Acceptable values are 0 to 1000, inclusive. |
page_token | string The maximum string length in characters is 2000. |
ListUserSshKeysResponse
Field | Description |
---|---|
ssh_keys[] | UserSshKey |
next_page_token | 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 |
Create
rpc Create (CreateUserSshKeyRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateUserSshKeyMetadata
Operation.response:UserSshKey
CreateUserSshKeyRequest
Field | Description |
---|---|
organization_id | string Required. The maximum string length in characters is 50. |
subject_id | string Required. The maximum string length in characters is 50. |
name | string The maximum string length in characters is 255. |
data | string Required. The maximum string length in characters is 20000. |
expires_at | google.protobuf.Timestamp |
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 | 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
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 |
Update
rpc Update (UpdateUserSshKeyRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:UpdateUserSshKeyMetadata
Operation.response:UserSshKey
UpdateUserSshKeyRequest
Field | Description |
---|---|
user_ssh_key_id | string Required. The maximum string length in characters is 50. |
name | string The maximum string length in characters is 255. |
update_mask | google.protobuf.FieldMask |
expires_at | google.protobuf.Timestamp |
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 | 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
UpdateUserSshKeyMetadata
Field | Description |
---|---|
user_ssh_key_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 |
Delete
rpc Delete (DeleteUserSshKeyRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteUserSshKeyMetadata
Operation.response:google.protobuf.Empty
DeleteUserSshKeyRequest
Field | Description |
---|---|
user_ssh_key_id | string Required. The maximum string length in characters is 50. |
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 | 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. |
result | oneof: error or 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. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteUserSshKeyMetadata
Field | Description |
---|---|
user_ssh_key_id | string |