Skip to main content

Lists a page of assigned grids

POST 
/api/web/v2/gridspaged/assigned

Returns assigned grids for the provided search parameters. Caller requires the GRIDS:VIEW permission. The following searchByAttributes are supported:

  • serialNumber: a numeric value. Allowed operators are: EQUALS, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
  • state: ACTIVE, INACTIVE, PENDING, CANCELED. Allowed operator: EQUALS.
  • expired: 'true' is the only value allowed. Allowed operator: EQUALS.
  • createDate: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
  • expiryDate: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
  • lastUsedDate: a String value representing an ISO-8601 date in UTC time (e.g., 2018-08-04T18:15:30). Allowed operators are: GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL.
  • userId: a String value. Allowed operators are: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH.
  • groupId: a String value should be a UUID of an existing group. Allowed operator: EQUALS.
If you provide more than one search attribute, they are joined with an AND condition.

The orderByAttribute supports these attribute names: serialNumber, state, createDate, expiryDate, lastUsedDate, userId.
The results will only include grids that contain data in the orderByAttribute selected.

Request​

Body

required

    attributes string[]

    Users search only: additional, non-core attributes to include in the returned object. Attribute names are specific to the returned object.

    cursor string

    Identifies the page to return when paging over a result set--if present, search by / order by attributes are ignored.

    limit int32

    Possible values: >= 1 and <= 100

    Identifies the maximum number of items to include in a page (1-100).

    orderByAttribute

    object

    An attribute used to sort the result from a search.

    ascending booleanrequired

    Identifies whether to order results in ascending order.

    name stringrequired

    Identifies the attribute.

    searchByAttributes

    object[]

    Identifies attributes for searching purposes. Some end-points have pre-defined values and ignore this attribute.

  • Array [

    • name stringrequired

    Identifies the attribute we are searching for.

    operator stringrequired

    Possible values: [EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, IN, EXISTS, NOT_EXISTS]

    Identifies the operator.

    value string

    Identifies the value of the attribute we are searching for.

  • ]

Responses​

Successful

Schema

    paging

    object

    Contains navigation information.

    limit int32required

    Possible values: >= 1 and <= 100

    The page limit used (1-100)

    nextCursor string

    The cursor pointing to the next page.

    prevCursor string

    The cursor pointing to the previous page.

    results

    object[]

    required

    A single page from the list of GRIDs found.

  • Array [

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