Skip to main content

Get a grid by serial number

GET 
/api/web/v2/grids/sernum/:sernum

Get the grid for the specified serial number. Caller requires the GRIDS:VIEW permission.

Request​

Path Parameters

    sernum int64required

    The serial number of the grid to be retrieved.

Responses​

Successful

Schema

    allowedActions string[]

    Possible values: [CANCEL, DELETE, ENABLE, DISABLE, ASSIGN, UNASSIGN]

    A list of what actions are currently allowed for this grid.

    assignDate date-time

    For unassigned grids which were assigned to the user, the date on which the grid was assigned.

    createDate date-time

    The date on which the grid was created.

    expired boolean

    A flag indicating if this grid is currently expired.

    expiryDate date-time

    If the grid policy defines an expiry date, the date on which this grid will expire. Expired grids cannot be used for authentication.

    gridContents array[]

    The grid contents of this grid. Only administrators with the GRIDCONTENTS:VIEW permission will receive this value.

    groups 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.

    id string

    The unique UUID assigned to the grid when it is created.

    lastUsedDate date-time

    The date on which this grid was last used for authentication. This value will be null if the grid has never been used.

    serialNumber int64

    The unique numeric serial number assigned to the grid when it is created.

    state string

    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.

    userId string

    The UUID of the user who owns this grid. If the grid is not assigned, this value will be null.

    userName string

    The user Id for this user. If the grid is not assigned, this value will be null.

Loading...