Skip to main content

Create a grid

POST 
/api/web/v2/users/:userid/grids

Create a grid for the specified user. Caller requires the GRIDS:ADD permission.

Request​

Path Parameters

    userid stringrequired

    The UUID of the user for which a grid will be created.

    Example: 2c422a2f-e8ae-4af8-8b03-e1ce0ddde0b0

Body

    emailParms

    object

    The parameters passed to customize email delivery to a user

    emailAttributeName string

    The name of the user attribute to use for email delivery. If not provided, the system-defined email attribute will be used.

    gridContent array[]

    If provided, the given grid contents are used for the new Grid Card. The grid contents must match the grid settings for grid size, grid cell size and cell alphabet. The administrator must have the GRIDCONTENTS:ADD permission to set the grid contents. This argument is ignored when creating unassigned grids.

    groups string[]

    When creating unassigned grids the list of UUIDs of groups to which the grids will belong. If not specified, the grids will not belong to any groups.

    numberOfGrids int32

    Possible values: >= 1 and <= 1000

    The number of grids to create when creating unassigned grids. If not specified, it defaults to 1.

    serialNumber int64

    Possible values: >= 1

    If provided, the given grid serial number is used for the new Grid Card.

    state string

    Possible values: [ACTIVE, INACTIVE, UNASSIGNED, PENDING, CANCELED]

    The state (ACTIVE, INACTIVE, or PENDING) of the new grid. If not specified, the state defaults to PENDING. This argument is ignored when creating unassigned grids.

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