Skip to content
View as Markdown

KeyResponse

Field Type Description
id uint64 The ID of the key to be used for revocation and further operations.
created_at google.protobuf.Timestamp The creation time of the key.
expires_at google.protobuf.Timestamp An optional expiration time for the key. If the key expires the behavior will be similar to revocation which will cause an unauthenticated response to be returned.
revoked bool Whether the key was explicitly revoked.
sdk_key bitdrift.public.unary.admin.v1.SdkKeyResponse The SDK key details when this key is an SDK key.

(Only one of sdk_key, or api_key can be set)
api_key bitdrift.public.unary.admin.v1.ApiKeyResponse The API key details when this key is an API key.

(Only one of api_key, or sdk_key can be set)
name string The name of the key, used for (human) identification purposes.

Example

JSON
{
  "created_at": "2024-01-15T09:30:00Z",
  "expires_at": "2024-01-15T09:30:00Z",
  "id": 1,
  "name": "My Workflow",
  "revoked": false,
  "sdk_key": {
    "app_id_postfix": "com.example.app",
    "bundle_id_regex": "com.example.*",
    "key": "example-key"
  }
}