Users

get

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

Authorizations

Path parameters

portalIdstringrequired

Query parameters

afterstring

limitnumber

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/partner-portals/{portalId}/users' \
  --header 'Authorization: Bearer JWT'

200

200

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

get

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

Authorizations

Path parameters

userIdstringrequired

portalIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/partner-portals/{portalId}/users/{userId}' \
  --header 'Authorization: Bearer JWT'

200

200

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

post

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

Authorizations

Path parameters

portalIdstringrequired

Body

first_namestringrequired

last_namestringrequired

emailstringrequired

passwordstring

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

localestring · default: en_US

User locale, used for time and numbers formatting.

attributesobject[]

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

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/partner-portals/{portalId}/users' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "first_name": "text",
    "last_name": "text",
    "email": "text",
    "password": "text",
    "roles": [
      "text"
    ],
    "locale": "en_US",
    "attributes": [
      {
        "id": "text",
        "value": "text"
      }
    ]
  }'

200

200

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

delete

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

Authorizations

Path parameters

userIdstringrequired

portalIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v1/partner-portals/{portalId}/users/{userId}' \
  --header 'Authorization: Bearer JWT'

200

200

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