Skip to main content

Get a list of users

GET 
/Users

Retrieve a list of users based on the applied filter.

Request​

Query Parameters

    userRoleCheck string

    If you have chosen the GET_ONE method type then you need to pass the roleName parameter

    filter stringrequired

    Filter criteria for retrieving users. Note: Encoding Objects for Query String Parameters When passing an object as part of the query string parameters in a URL, you must encode the object to ensure it is correctly interpreted by the server. To encode the object:

    1. Use the encodeURIComponent() method in the browser, which converts the object into a valid URL-encoded string. 2.Pass the encoded string as the query string parameter. example: encodeURIComponent(' {"roleName":"administrator"}')
    pagination stringrequired

    Pagination parameters. Note: Encoding Objects for Query String Parameters When passing an object as part of the query string parameters in a URL, you must encode the object to ensure it is correctly interpreted by the server. To encode the object:

    1. Use the encodeURIComponent() method in the browser, which converts the object into a valid URL-encoded string. 2.Pass the encoded string as the query string parameter. example: encodeURIComponent('{"page":1,"perPage":5,"serverSidePaginationEnabled":false,"totalCount":0}')
    type stringrequired

    Type of method example: GET_LIST, GET_ONE

    roleName string

    If you have chosen the GET_ONE method type then you need to pass the roleName parameter

Header Parameters

    X-Api-Key string

    Please provide the api here

Responses​

200 response

Response Headers

  • Access-Control-Expose-Headers

    string

    Manages CORS exposed headers.

  • Access-Control-Allow-Origin

    string

    Manages CORS.

  • Content-Range

    string

    Data range of result.

  • X-Total-Count

    string

    Length of output.

  • Access-Control-Allow-Headers

    string

    Manages header for CORS.

  • Content-Type

    string

    Data type of content.

Schema

    usersList

    object[]

  • Array [

    • lastName stringrequired

    The last name of the user.

    orgName stringrequired

    The organization name of the user.

    discountClasses string

    Discount classes assigned to the user.

    Manuals string

    Manuals information for the user.

    AssetsVersion string

    Assets version for the user.

    label stringrequired

    The label assigned to the user.

    securityGroup string

    Security groups assigned to the user.

    Maintenance string

    Maintenance information for the user.

    userName stringrequired

    The username of the user.

    type stringrequired

    The type of the user.

    userLoginType stringrequired

    The login type of the user.

    lastModifiedOn date-time

    The date and time when the user was last modified.

    firstName stringrequired

    The first name of the user.

    MaintenanceVersion string

    Maintenance version for the user.

    cognitoUserStatus stringrequired

    The Cognito user status of the user.

    ManualsVersion string

    Manuals version for the user.

    Assets string

    Assets information for the user.

    name stringrequired

    The full name of the user.

    id stringrequired

    The unique identifier for the user.

    createDate date-timerequired

    The date and time when the user was created.

    status stringrequired

    The status of the user.

  • ]

Loading...