Developer Portal
  • Introduction
  • API Endpoint
  • Authentication
  • Errors
  • Rate Limiting
  • Pagination
  • Request IDs
  • API reference
    • Partner portals
      • Users
    • User attributes
    • Roles
    • Warehouses
      • Persistence Engine
Powered by GitBook
On this page

Was this helpful?

  1. API reference
  2. Partner portals

Users

PreviousPartner portalsNextUser attributes

Last updated 2 years ago

Was this helpful?

get
Authorizations
Path parameters
portalIdstringRequired
Query parameters
afterstringOptional
limitnumberOptional
Responses
200Success
application/json
Responseall of
and
get
GET /v1/partner-portals/{portalId}/users HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
{
  "paging": {
    "next": {
      "after": "text"
    }
  },
  "data": [
    {
      "id": "text",
      "first_name": "text",
      "last_name": "text",
      "email": "text",
      "last_logged_at": 1
    }
  ]
}
get
Authorizations
Path parameters
userIdstringRequired
portalIdstringRequired
Responses
200Success
application/json
get
GET /v1/partner-portals/{portalId}/users/{userId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
{
  "id": "text",
  "first_name": "text",
  "last_name": "text",
  "email": "text",
  "last_logged_at": 1
}
delete
Authorizations
Path parameters
userIdstringRequired
portalIdstringRequired
Responses
200Success
application/json
delete
DELETE /v1/partner-portals/{portalId}/users/{userId} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
{
  "id": "text",
  "isDeleted": true
}
  • GET/v1/partner-portals/{portalId}/users
  • GET/v1/partner-portals/{portalId}/users/{userId}
  • POST/v1/partner-portals/{portalId}/users
  • DELETE/v1/partner-portals/{portalId}/users/{userId}
post
Authorizations
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
post
POST /v1/partner-portals/{portalId}/users HTTP/1.1
Host: 
Authorization: Bearer JWT
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": 1
}