Get User by User Id

get

Get User by User Id

Use this endpoint to get a user's details from a userId. You will get back the userId, userActive status, the products the user is registered to, and a list of device objects with deviceIds and whether they are active or inactive.

Resource URL

https://api-sandbox.arity.com/registration/v2/users/{userId}

Query Parameters


Name Values Description
limit

Specifies the maximum number of records to return within the current page of results.

offset

Specifies the page of records to return. Zero based indexing (0 – Page 1, 1 – Page 2, et al.)


Header Parameters


Name Values Description
Authorization
(required)

Access Token

userId UserId of user whose details to retrieve null true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400
    400

    Bad Request response

  • 401
    401

    Unauthorized response

  • 500
    500

    Server Error response

Resource Summary

Security

None

Category

Users

Name Type Description
Name Type Description
userIdstringid of the user that the device belongs to
userActivebooleantrue, if the user is Active and false if the user is inactive
productsarrayproducts the user is registered to
devicesarrayList of devices the user is registered to
devices[]
.deviceId
stringid of the device
devices[]
.status
stringactive or inactive

Working...

© 2019 Arity, LLC. All rights reserved.  | Privacy Policy | Terms of Use | Legacy APIs