Generate an API key's backup secret
POST/auth/api_keys/:id/backup_secret
Generates a new backup secret for an API key.
Request
Path Parameters
The id
of the API Key
Responses
200: Successful response
- application/json
- Schema
- Example (from schema)
Schema
data
object
uuid.
Human readable identifier.
Secret used to authenticate API Key.
Secondary secret which may also be used to authenticate API Key.
Status of the API Key.
Array of ids of Permission Groups on the API Key.
True if the API Key has admin rights, false otherwise.
Record type.
Timestamp of resource creation.
Timestamp of last resource update.
{
"data": {
"id": "f30e7596-586e-44e1-ae7d-53db10f144d3",
"description": "Tommy's Key",
"secret": "XXXXXXXXXXXXX",
"backup_secret": "XXXXXXXXXXXXX",
"status": "active",
"permission_groups": [
"string"
],
"admin": true,
"record_type": "api_key",
"created_at": "2018-02-08T18:49:22.998023Z",
"updated_at": "2018-02-08T18:49:22.998023Z"
}
}
401: Authentication error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
object[]
an application-specific error code, expressed as a stringified integer.
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
JSON pointer to the field which is causing the error.
{
"errors": [
{
"code": "10001",
"title": "error title",
"detail": "additional detail about the error",
"pointer": "/pointer/to/field"
}
]
}
403: Authorization error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
object[]
an application-specific error code, expressed as a stringified integer.
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
JSON pointer to the field which is causing the error.
{
"errors": [
{
"code": "10001",
"title": "error title",
"detail": "additional detail about the error",
"pointer": "/pointer/to/field"
}
]
}
404: Resource not found
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
object[]
an application-specific error code, expressed as a stringified integer.
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
JSON pointer to the field which is causing the error.
{
"errors": [
{
"code": "10001",
"title": "error title",
"detail": "additional detail about the error",
"pointer": "/pointer/to/field"
}
]
}