Users

get

Authorizations

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Path parameters

portalIdstringRequired

Query parameters

afterstringOptional

limitnumberOptional

Responses

200Success

application/json

get/v1/partner-portals/{portalId}/users

GET /v1/partner-portals/{portalId}/users HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "paging": {
    "next": {
      "after": "text"
    }
  },
  "data": [
    {
      "id": "text",
      "first_name": "text",
      "last_name": "text",
      "email": "text",
      "last_logged_at": "text"
    }
  ]
}

get

Authorizations

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Path parameters

userIdstringRequired

portalIdstringRequired

Responses

200Success

application/json

idstringRequired

Unique ID for the Portal User.

first_namestringRequired

First name of the User.

last_namestringRequired

Last name of the User.

emailstringRequired

Email of the User.

last_logged_atstringRequired

Last login date and time of the user (ISO 8601 format)

get/v1/partner-portals/{portalId}/users/{userId}

GET /v1/partner-portals/{portalId}/users/{userId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "text",
  "last_logged_at": "text"
}

post

Authorizations

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Path parameters

portalIdstringRequired

Body

first_namestringRequired

last_namestringRequired

emailstringRequired

passwordstringOptional

When set, this will be the password of the User that he/she can use at the first connection.

rolesstring[]Required

Contains the list of Role Ids that should be granted to this Portal User

localestringOptional

User locale, used for time and numbers formatting.

Default: en_US

Responses

200Success

application/json

idstringRequired

Unique ID for the Portal User.

first_namestringRequired

First name of the User.

last_namestringRequired

Last name of the User.

emailstringRequired

Email of the User.

last_logged_atstringRequired

Last login date and time of the user (ISO 8601 format)

post/v1/partner-portals/{portalId}/users

POST /v1/partner-portals/{portalId}/users HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 151

{
  "first_name": "text",
  "last_name": "text",
  "email": "text",
  "password": "text",
  "roles": [
    "text"
  ],
  "locale": "en_US",
  "attributes": [
    {
      "id": "text",
      "value": "text"
    }
  ]
}

200Success

{
  "id": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "text",
  "last_logged_at": "text"
}

delete

Authorizations

AuthorizationstringRequired

Pass a Service Account Key as the Bearer token to authenticate. e.g. 'sk:xxxxxxx'

Path parameters

userIdstringRequired

portalIdstringRequired

Responses

200Success

application/json

idstringRequired

isDeletedbooleanRequired

delete/v1/partner-portals/{portalId}/users/{userId}

DELETE /v1/partner-portals/{portalId}/users/{userId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "id": "text",
  "isDeleted": true
}