Users API endpoints

Kathyana Queeman
  • Updated

Download Postman collection

Users API endpoints

Relative URI

Method

Success code

Description

/ashares

GET

200

Retrieves the list of all users from your account along with their access level and other attributes.

/ashares/<id>

GET

200

Retrieves a specific user.

PUT

204

Update a specific user’s account.

DELETE

204

Deletes a specific user.

/ashares/<id>/disable

PUT

204

Disables a specific user’s account.

ashares/invite

POST

201

Invite a user to the account.

/ashares/<id>/reinvite

PUT

204

Reshare the account access to a user.

/ssoclients/<id>

PATCH

204

Update a specific part of a user's SSO client.

There is one SSO client field you can update using a PATCH:

Field

Data type

disabled

boolean

Users API examples

Get Users

GET /v1/ashares HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token
Sample response
[

 {
      "_id":"554••••••••••••••••••00d",
      "accepted":true,
      "accessLevel":"manage",
      "integrationAccessLevel":
      [
          {
            "_integrationId":"554••••••••••••••••••00d8",
            "accessLevel":"manage"
         },
      ],
      "accountSSORequired":false,
      "lastModified":"2022-01-18T22:50:37.665Z",
      "sharedWithUser":{
         "_id":"554••••••••••••••••••00dj",
         "email":"youremail@domain.com",
         "name":"John Smith",
         "allowedToResetMFA":false,
         "accountSSOLinked":"not_linked"
   }

]

Enable or disable a user

PUT /v1/ashares/63•••••••••••••••••••/disable HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token
Sample response
Error : 404 
{"errors":[{"code":"access_restricted","message":"The account which you are trying to access has not been shared with you."}]}

Edit user

You cannot change the email address

PUT /v1/ashares/63•••••••••••••••••••9 HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token
Sample response
{
"_id": "k3os•••••••••••••••••••23k,
"email": "email@email.com",
"accessLevel": "administrator",
"accountMFARequired": false,
...}

Invite user

POST /v1/ashares/invite HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token
Sample response
{
"_id": "k3os•••••••••••••••••••23k,
"email": "email@email.com",
"accessLevel": "administrator",
"accountMFARequired": false,
...}

Get a specific user

GET /v1/ashares/64••••••••••••••••••cf8 HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token
Sample response
{
    "_id":"64••••••••••••••••••cf8",
    "email":"email@email.com",
    "accessLevel":"administrator",
    "integrationAccessLevel":[],
    "accountSSORequired":false,
    "accountMFARequired":false
    }

Related articles

Comments

1 comment

Date Votes

Please sign in to leave a comment.