Create a temporary access code
POST/api/web/v1/users/:userid/tempaccesscode
Create a temporary access code for the given user. Caller requires the TEMPACCESSCODE:ADD permission.
Request
Path Parameters
The UUID of the user for which a temporary access code will be created.
Responses
- 200
- 400
- 401
- 403
- 404
- 409
Successful
- application/json
- Schema
- Example (from schema)
Schema
The actual temporary access code. This value will only be returned if the administrator has the TEMPACCESSCODECONTENTS:VIEW permission.
The date on which this temporary access code was created.
A flag indicating if this temporary access code is expired now.
The expiry date of this temporary access code. If not set, it never expires.
The unique UUID assigned to the temporary access code when it is created.
The maximum number of times this temporary access code can be used. If not set, there are no limits.
The number of times this temporary access code has been used.
{
"code": "string",
"createDate": "2019-02-19T13:15:27Z",
"expired": true,
"expiryDate": "2019-03-19T13:15:27Z",
"id": "string",
"maxUses": 0,
"numUses": 0
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Access denied
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}
Conflict
- application/json
- Schema
- Example (from schema)
Schema
Error Codes specific to cause of failure.
Additional Error Message describing the error.
Optional additional error information.
{
"errorCode": "invalid_user_response",
"errorMessage": "Application id cannot be null",
"parameters": [
{}
]
}