Users

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

Authorization

bearer

Path parameters

portalId*string

Query parameters

Response

200

Body

application/json

paging*PagingInfo (object)

dataarray of PartnerPortalUserDto (object)

Request

JavaScriptCurlPython

const response = await fetch('/v1/partner-portals/{portalId}/users', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

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

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

Authorization

bearer

Path parameters

userId*string

portalId*string

Response

200

Body

application/json

id*string

Unique ID for the Portal User.

first_name*string

First name of the User.

last_name*string

Last name of the User.

email*string

Email of the User.

last_logged_at*number

Unix timestamp of user's last login.

Request

JavaScriptCurlPython

const response = await fetch('/v1/partner-portals/{portalId}/users/{userId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

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

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

Authorization

bearer

Path parameters

portalId*string

Body

application/json

first_name*string

last_name*string

email*string

passwordstring

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

roles*array of string

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

localestring

User locale, used for time and numbers formatting.

attributesarray of object

When set, this will define the user attributes on its creation.

Response

200

Body

application/json

id*string

Unique ID for the Portal User.

first_name*string

First name of the User.

last_name*string

Last name of the User.

email*string

Email of the User.

last_logged_at*number

Unix timestamp of user's last login.

Request

JavaScriptCurlPython

const response = await fetch('/v1/partner-portals/{portalId}/users', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "first_name": "text",
      "last_name": "text",
      "email": "text",
      "roles": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

200

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

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

Authorization

bearer

Path parameters

userId*string

portalId*string

Response

200

Body

application/json

id*string

isDeleted*boolean

Request

JavaScriptCurlPython

const response = await fetch('/v1/partner-portals/{portalId}/users/{userId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

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