Skip to main content

api_key.proto

path mgmt/v1alpha1/api_key.proto

package mgmt.v1alpha1


Messages

AccountApiKey

NameTypeDescription
idstringThe unique identifier of the API key
namestringThe friendly name of the API Key
account_idstringThe unique identifier of the account that the API key belongs to
created_by_idstringThe unique identifier of the user that created the API key
created_atgoogle.protobuf.TimestampThe timestamp of when the API key was created
updated_by_idstringThe unique identifier of the user that last updated the API key
updated_atgoogle.protobuf.TimestampThe timestamp of when the API key was last updated
key_valueoptional stringkey_value is only returned on initial creation or when it is regenerated
user_idstringThe 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_atgoogle.protobuf.TimestampThe timestamp of what the API key expires and will not longer be usable.

CreateAccountApiKeyRequest

NameTypeDescription
account_idstringThe unique identifier of the account to create the API key for.
namestringThe friendly name of the API key
expires_atgoogle.protobuf.TimestampValidate between now and one year: now < x < 365 days

CreateAccountApiKeyResponse

NameTypeDescription
api_keyAccountApiKeyThe created API key

DeleteAccountApiKeyRequest

NameTypeDescription
idstringThe unique identifier of the API key to delete.

DeleteAccountApiKeyResponse

NameTypeDescription

GetAccountApiKeyRequest

NameTypeDescription
idstringThe unique identifier of the API key to get.

GetAccountApiKeyResponse

NameTypeDescription
api_keyAccountApiKeyThe API key that was retrieved.

GetAccountApiKeysRequest

NameTypeDescription
account_idstringThe unique identifier of the account to get the API keys for.

GetAccountApiKeysResponse

NameTypeDescription
api_keysrepeated AccountApiKeyThe list of API keys for the account.

RegenerateAccountApiKeyRequest

NameTypeDescription
idstringThe unique identifier of the API key to regenerate.
expires_atgoogle.protobuf.TimestampValidate between now and one year: now < x < 365 days

RegenerateAccountApiKeyResponse

NameTypeDescription
api_keyAccountApiKeyThe regenerated API key

Services

ApiKeyService

Service that manages the lifecycle of API Keys that are associated with a specific Account.

GetAccountApiKeys

MethodGetAccountApiKeys
RequestGetAccountApiKeysRequest
ResponseGetAccountApiKeysResponse
DescriptionRetrieves a list of Account API Keys

GetAccountApiKey

MethodGetAccountApiKey
RequestGetAccountApiKeyRequest
ResponseGetAccountApiKeyResponse
DescriptionRetrieves a single API Key

CreateAccountApiKey

MethodCreateAccountApiKey
RequestCreateAccountApiKeyRequest
ResponseCreateAccountApiKeyResponse
DescriptionCreates a single API Key This method will return the decrypted contents of the API key

RegenerateAccountApiKey

MethodRegenerateAccountApiKey
RequestRegenerateAccountApiKeyRequest
ResponseRegenerateAccountApiKeyResponse
DescriptionRegenerates a single API Key with a new expiration time This method will return the decrypted contents of the API key

DeleteAccountApiKey

MethodDeleteAccountApiKey
RequestDeleteAccountApiKeyRequest
ResponseDeleteAccountApiKeyResponse
DescriptionDeletes an API Key from the system.