Get a temporary access code

GET 
/api/web/v1/users/:userid/tempaccesscode

Get the temporary access code for the given user. Caller requires the TEMPACCESSCODE:VIEW permission.

Request

Path Parameters

userid stringrequired

The UUID of the user whose temporary access code will be fetched.

Responses

200

Successful

application/json

Schema

Schema

code string

The actual temporary access code. This value will only be returned if the administrator has the TEMPACCESSCODECONTENTS:VIEW permission.

createDate date-time

The date on which this temporary access code was created.

expired boolean

A flag indicating if this temporary access code is expired now.

expiryDate date-time

The expiry date of this temporary access code. If not set, it never expires.

id string

The unique UUID assigned to the temporary access code when it is created.

maxUses int32

The maximum number of times this temporary access code can be used. If not set, there are no limits.

numUses int32

The number of times this temporary access code has been used.

Example (from schema)

{
  "code": "string",
  "createDate": "2019-02-19T13:15:27Z",
  "expired": true,
  "expiryDate": "2019-03-19T13:15:27Z",
  "id": "string",
  "maxUses": 0,
  "numUses": 0
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...