Skip to main content

Lists a page of unassigned hardware tokens

POST 
/api/web/v1/tokenspaged/unassigned

Returns unassigned hardware tokens for the provided search parameters. Caller requires the TOKENS:VIEW permission.The following searchByAttributes are supported:

  • serialNumber: a String up to 100 characters. Allowed operators are: EQUALS, CONTAINS, STARTS_WITH.
  • type: OATH_PHYSICAL_TOKEN or ENTRUST_LEGACY_TOKEN. Allowed operator: EQUALS.
  • loadDate: 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.
  • groupId: a String value should be a UUID of an existing group. Allowed operator: EQUALS.
The orderByAttribute supports these attribute names: serialNumber.

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 with the list of assigned tokens found.

  • Array [

    • algorithmType string

    Possible values: [AT, OATH_HOTP, OATH_OCRA, OATH_TOTP, VENDOR]

    The algorithm type used by the token that was created or loaded into the system to generate OTP values.

    allowedActions string[]

    Possible values: [ACTIVATE, REACTIVATE, ACTIVATE_COMPLETE, DELETE, UNLOCK, ENABLE, DISABLE, RESET, ASSIGN, UNASSIGN]

    Actions that can be performed on this token.

    description string

    Optional text describing this token.

    groups string[]

    The UUIDs of groups to which this token belongs. This value is only used for unassigned tokens. Only groups to which the current administrator has access will be returned.

    id string

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

    label string

    Optional label to identify an assigned token: a String up to 100 characters.

    lastUsedDate date-time

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

    loadDate date-time

    The date on which the token was created or loaded into the system.

    logo string

    Base-64 encoded logo. If a custom logo is provided by the customer it is returned. Otherwise a system default logo is returned.

    name string

    An optional name for the token.

    platform string

    The mobile device platform on which an Entrust Soft Token was activated.

    registeredForTransactions boolean

    A flag indicating if the Entrust Soft Token has registered for transactions. Only tokens that are registered can perform token push authentication.

    serialNumber string

    The serial number of the token either generated when the token was created or loaded into the system.

    state string

    Possible values: [NEW, ACTIVATING, ACTIVE, INACTIVE, UNASSIGNED]

    The state of the token. For most tokens, only tokens in the ACTIVE state can be used for authentication. Google Authenticator tokens in the ACTIVATING state can also be used for authentication.

    supportsChallengeResponse boolean

    A flag indicating if the Token supports challenge response processing.

    supportsResponse boolean

    A flag indicating if the Token supports response processing.

    supportsSignature boolean

    A flag indicating if the Token supports signature processing.

    supportsUnlock boolean

    A flag indicating if the Token supports unlock processing.

    supportsUnlockTOTP boolean

    A flag indicating if the Token supports unlock using TOTP processing.

    type string

    Possible values: [ENTRUST_PHYSICAL_TOKEN, ENTRUST_SOFT_TOKEN, GOOGLE_AUTHENTICATOR, OATH_PHYSICAL_TOKEN, ENTRUST_LEGACY_TOKEN]

    The type of token specified when the token was created or loaded into the system.

    userId string

    If the token is assigned to a user, this value specifies that user's user id.

  • ]

Loading...