api_key.proto
path mgmt/v1alpha1/api_key.proto
package mgmt.v1alpha1
Messages
AccountApiKey
| Name | Type | Description |
|---|---|---|
id | string | |
name | string | The friendly name of the API Key |
account_id | string | |
created_by_id | string | |
created_at | google.protobuf.Timestamp | |
updated_by_id | string | |
updated_at | google.protobuf.Timestamp | |
key_value | optional string | key_value is only returned on initial creation or when it is regenerated |
user_id | string | |
expires_at | google.protobuf.Timestamp | The timestamp of what the API key expires and will not longer be usable. |
CreateAccountApiKeyRequest
| Name | Type | Description |
|---|---|---|
account_id | string | |
name | string | |
expires_at | google.protobuf.Timestamp | Validate between now and one year: now < x < 365 days |
CreateAccountApiKeyResponse
| Name | Type | Description |
|---|---|---|
api_key | AccountApiKey |
DeleteAccountApiKeyRequest
| Name | Type | Description |
|---|---|---|
id | string |
DeleteAccountApiKeyResponse
| Name | Type | Description |
|---|
GetAccountApiKeyRequest
| Name | Type | Description |
|---|---|---|
id | string |
GetAccountApiKeyResponse
| Name | Type | Description |
|---|---|---|
api_key | AccountApiKey |
GetAccountApiKeysRequest
| Name | Type | Description |
|---|---|---|
account_id | string |
GetAccountApiKeysResponse
| Name | Type | Description |
|---|---|---|
api_keys | repeated AccountApiKey |
RegenerateAccountApiKeyRequest
| Name | Type | Description |
|---|---|---|
id | string | |
expires_at | google.protobuf.Timestamp | Validate between now and one year: now < x < 365 days |
RegenerateAccountApiKeyResponse
| Name | Type | Description |
|---|---|---|
api_key | AccountApiKey |
Services
ApiKeyService
Service that manages the lifecycle of API Keys that are associated with a specific Account.
GetAccountApiKeys
| Method | GetAccountApiKeys |
|---|---|
| Request | GetAccountApiKeysRequest |
| Response | GetAccountApiKeysResponse |
| Description | Retrieves a list of Account API Keys |
GetAccountApiKey
| Method | GetAccountApiKey |
|---|---|
| Request | GetAccountApiKeyRequest |
| Response | GetAccountApiKeyResponse |
| Description | Retrieves a single API Key |
CreateAccountApiKey
| Method | CreateAccountApiKey |
|---|---|
| Request | CreateAccountApiKeyRequest |
| Response | CreateAccountApiKeyResponse |
| Description | Creates a single API Key This method will return the decrypted contents of the API key |
RegenerateAccountApiKey
| Method | RegenerateAccountApiKey |
|---|---|
| Request | RegenerateAccountApiKeyRequest |
| Response | RegenerateAccountApiKeyResponse |
| Description | Regenerates a single API Key with a new expiration time This method will return the decrypted contents of the API key |
DeleteAccountApiKey
| Method | DeleteAccountApiKey |
|---|---|
| Request | DeleteAccountApiKeyRequest |
| Response | DeleteAccountApiKeyResponse |
| Description | Deletes an API Key from the system. |