api_key.proto
path mgmt/v1alpha1/api_key.proto
package mgmt.v1alpha1
Messages
AccountApiKey
| Name | Type | Description |
|---|---|---|
id | string | The unique identifier of the API key |
name | string | The friendly name of the API Key |
account_id | string | The unique identifier of the account that the API key belongs to |
created_by_id | string | The unique identifier of the user that created the API key |
created_at | google.protobuf.Timestamp | The timestamp of when the API key was created |
updated_by_id | string | The unique identifier of the user that last updated the API key |
updated_at | google.protobuf.Timestamp | The timestamp of when the API key was last updated |
key_value | optional string | key_value is only returned on initial creation or when it is regenerated |
user_id | string | The unique identifier of the user that the API key belongs to (Each API Key is associated with its own user record to identify what the API key does in the system) |
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 | The unique identifier of the account to create the API key for. |
name | string | The friendly name of the API key |
expires_at | google.protobuf.Timestamp | Validate between now and one year: now < x < 365 days |
CreateAccountApiKeyResponse
| Name | Type | Description |
|---|---|---|
api_key | AccountApiKey | The created API key |
DeleteAccountApiKeyRequest
| Name | Type | Description |
|---|---|---|
id | string | The unique identifier of the API key to delete. |
DeleteAccountApiKeyResponse
| Name | Type | Description |
|---|
GetAccountApiKeyRequest
| Name | Type | Description |
|---|---|---|
id | string | The unique identifier of the API key to get. |
GetAccountApiKeyResponse
| Name | Type | Description |
|---|---|---|
api_key | AccountApiKey | The API key that was retrieved. |
GetAccountApiKeysRequest
| Name | Type | Description |
|---|---|---|
account_id | string | The unique identifier of the account to get the API keys for. |
GetAccountApiKeysResponse
| Name | Type | Description |
|---|---|---|
api_keys | repeated AccountApiKey | The list of API keys for the account. |
RegenerateAccountApiKeyRequest
| Name | Type | Description |
|---|---|---|
id | string | The unique identifier of the API key to regenerate. |
expires_at | google.protobuf.Timestamp | Validate between now and one year: now < x < 365 days |
RegenerateAccountApiKeyResponse
| Name | Type | Description |
|---|---|---|
api_key | AccountApiKey | The regenerated API key |
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. |