Skip to main content

Grid

A Grid defines the information returned about a Grid.

Properties

NameTypeDescriptionNotes
allowedActionsList<AllowedActionsEnum>A list of what actions are currently allowed for this grid.[optional]
assignDateOffsetDateTimeFor unassigned grids which were assigned to the user, the date on which the grid was assigned.[optional]
createDateOffsetDateTimeThe date on which the grid was created.[optional]
expiredBooleanA flag indicating if this grid is currently expired.[optional]
expiryDateOffsetDateTimeIf the grid policy defines an expiry date, the date on which this grid will expire. Expired grids cannot be used for authentication.[optional]
gridContentsList<List<String>>The grid contents of this grid. Only administrators with the GRIDCONTENTS:VIEW permission will receive this value.[optional]
groupsList<String>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.[optional]
idStringThe unique UUID assigned to the grid when it is created.[optional]
lastUsedDateOffsetDateTimeThe date on which this grid was last used for authentication. This value will be null if the grid has never been used.[optional]
serialNumberLongThe unique numeric serial number assigned to the grid when it is created.[optional]
stateStateEnumThe state of this grid. Only grids in the ACTIVE or PENDING state can be used for authentication.[optional]
userIdStringThe UUID of the user who owns this grid. If the grid is not assigned, this value will be null.[optional]
userNameStringThe user Id for this user. If the grid is not assigned, this value will be null.[optional]

List<AllowedActionsEnum>

NameValue
CANCEL"CANCEL"
DELETE"DELETE"
ENABLE"ENABLE"
DISABLE"DISABLE"
ASSIGN"ASSIGN"
UNASSIGN"UNASSIGN"

StateEnum

NameValue
ACTIVE"ACTIVE"
INACTIVE"INACTIVE"
UNASSIGNED"UNASSIGNED"
PENDING"PENDING"
CANCELED"CANCELED"