GET
/
users
/
{user_id}
Get a user
curl --request GET \
  --url http://localhost:3001/portal-api/users/{user_id} \
  --header 'Authorization: <api-key>'
{
  "Active": true,
  "Email": "admin@acme.com",
  "First": "John",
  "Last": "Doe",
  "OrganisationID": 1,
  "Role": "consumer-team-member",
  "Provider": "password",
  "JWTToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJQcm92aWRlciI6Im5vbmUiLCJVc2VySUQiOiIkMmEkMTAkMFhRUEtCSC9nenFWMVhnRkRzUWViLk90bmdzVVlsQk9VSE14T045bWZveEs3ek9zSzVKLnkifQ.SHZtWNA-sYHUwSLEkWFo1r049WBWcQJVco_WH21jXHs",
  "APITokenCreatedAt": "2023-06-23",
  "Organisation": "Default Organisation",
  "ResetPassword": false,
  "Teams": [
    "Default Organisation All users"
  ],
  "ID": 1,
  "CreatedAt": "2023-06-23 21:02",
  "UpdatedAt": "2023-06-23 21:02"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
user_id
integer
required

UID of a user

Example:

1

Response

OK

​
Active
boolean

Defines if this user is active and can login to the portal

Example:

true

​
Email
string

Email of a user

Example:

"admin@acme.com"

​
First
string

First name of a user

Example:

"John"

​
Last
string

Last name of a user

Example:

"Doe"

​
OrganisationID
integer

ID of an organisation where this user belongs to. For admin users it is always equal to 0

Example:

1

​
Role
string

Role of a user in their organisation

Example:

"consumer-team-member"

​
Provider
string

Type of identity provider for this user, e.g. password, github, etc.

Example:

"password"

​
JWTToken
string

API access credentials to the admin APIs that are described in this spectification

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJQcm92aWRlciI6Im5vbmUiLCJVc2VySUQiOiIkMmEkMTAkMFhRUEtCSC9nenFWMVhnRkRzUWViLk90bmdzVVlsQk9VSE14T045bWZveEs3ek9zSzVKLnkifQ.SHZtWNA-sYHUwSLEkWFo1r049WBWcQJVco_WH21jXHs"

​
APITokenCreatedAt
string

Date-time when the JWTToken is created

Example:

"2023-06-23"

​
Organisation
string

Name of an rganisation where this user belongs to

Example:

"Default Organisation"

​
ResetPassword
boolean

Determines if a user must change their password at the next login

Example:

false

​
Teams
string[]

Name of this user's teams

​
ID
integer

UID of a user

Example:

1

​
CreatedAt
string

Date-time when a user is created

Example:

"2023-06-23 21:02"

​
UpdatedAt
string

Date-time when a user is updated the last time

Example:

"2023-06-23 21:02"