CreateKeyRequest¶
| Field | Type | Description |
|---|---|---|
| sdk_key | Creates an SDK key. (Only one of sdk_key, or api_key can be set) |
|
| api_key | Creates 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
{
"name": "My Workflow",
"sdk_key": {
"app_id_postfix": "com.example.app",
"bundle_id_regex": "com.example.*"
}
}
CreateKeyRequest.SdkKeyRequest¶
| Field | Type | Description |
|---|---|---|
| bundle_id_regex | string | The app/bundle ID regex that the key is associated with. |
| app_id_postfix | optional string | An optional postfix for the app ID associated with the key. This will be appended to the real app_id during the handshake. |
Example¶
JSON
{
"app_id_postfix": "com.example.app",
"bundle_id_regex": "com.example.*"
}
CreateKeyRequest.ApiKeyRequest¶
| Field | Type | Description |
|---|---|---|
| permissions | repeated bitdrift.public.unary.admin.v1.Permission | The permissions that the key should have. Must have at least one permission. |
Example¶
JSON
{
"permissions": [
"WORKFLOW_READ"
]
}