Get a grid
GET/api/web/v2/grids/:gridid
Get the specified grid. Caller requires the GRIDS:VIEW permission.
Request
Path Parameters
The UUID of the grid to be retrieved.
Responses
- 200
- 400
- 401
- 403
- 404
- 409
Successful
- application/json
- Schema
- Example (from schema)
Schema
Possible values: [CANCEL
, DELETE
, ENABLE
, DISABLE
, ASSIGN
, UNASSIGN
]
A list of what actions are currently allowed for this grid.
For unassigned grids which were assigned to the user, the date on which the grid was assigned.
The date on which the grid was created.
A flag indicating if this grid is currently expired.
If the grid policy defines an expiry date, the date on which this grid will expire. Expired grids cannot be used for authentication.
The grid contents of this grid. Only administrators with the GRIDCONTENTS:VIEW permission will receive this value.
The UUIDs of groups to which this grid belongs. This value is only used for unassigned grids. Only groups to which the current administrator has access will be returned.
The unique UUID assigned to the grid when it is created.
The date on which this grid was last used for authentication. This value will be null if the grid has never been used.
The unique numeric serial number assigned to the grid when it is created.
Possible values: [ACTIVE
, INACTIVE
, UNASSIGNED
, PENDING
, CANCELED
]
The state of this grid. Only grids in the ACTIVE or PENDING state can be used for authentication.
The UUID of the user who owns this grid. If the grid is not assigned, this value will be null.
The user Id for this user. If the grid is not assigned, this value will be null.
{
"allowedActions": [
"CANCEL"
],
"assignDate": "2019-02-19T13:17:27Z",
"createDate": "2019-02-19T13:15:27Z",
"expired": true,
"expiryDate": "2019-08-19T13:15:27Z",
"gridContents": [
[
"string"
]
],
"groups": [
"string"
],
"id": "string",
"lastUsedDate": "2019-02-19T13:15:27Z",
"serialNumber": 0,
"state": "ACTIVE",
"userId": "45f5a855-962a-4b5f-b5c5-7ceeae235875",
"userName": "john.doe"
}
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": [
{}
]
}