Skip to content
/
Creates a user and adds t...

Wia REST API User reference (v1)


A REST API to interact with Wia platform for user management for external IAM teams.

To get started, please ensure you have the correct permissions and appropriate client credentials. If you have not been provided client credentials, please contact your representative.

The API is organised around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Download OpenAPI description
swaggerForUserManagement.json
swaggerForUserManagement.yaml
Languages
Servers
Mock server
https://docs.wia.io/_mock/apis/wia-user-management-api/swaggerforusermanagement
Production
https://api.wia.io/v1

Auth

Endpoints related to authentication, including login, token management, and authorisation.

Operations

Organisation

Endpoints that handle organisation-related operations, such as creation, management, and user assignments.

Operations

Creates a user and adds them to an organisation

Request

Creates a user and adds them to an organisation

Security
Organisation
Bodyapplication/json
emailAddressstringrequired

Email Address of the user

fullNamestring

Name of the user

passwordstring

Password for login

loginViaSsoOnlystring

Boolean to indicate if the user can only login via SSO (Password will be ignored)

curl -i -X POST \
  https://docs.wia.io/_mock/apis/wia-user-management-api/swaggerforusermanagement/organisations/users/ \
  -H 'Authorization: Bearer <YOUR_Bearer_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "emailAddress": "string",
    "fullName": "string",
    "password": "string",
    "loginViaSsoOnly": "string"
  }'

Responses

OK

Bodyapplication/json
idstring
Example: "ou_abc123def"
firstNamestring
Example: "Pina"
lastNamestring
Example: "Colada"
fullNamestring
Example: "Pina Colada"
userIdstring
Example: "usr_abc123def"
emailAddressstring
Example: "pina.colada@wia.io"
isAdminboolean
Example: false
teamsArray of objects(Team)
Response
application/json
{
  "id": "ou_abc123def",
  "firstName": "Pina",
  "lastName": "Colada",
  "fullName": "Pina Colada",
  "userId": "usr_abc123def",
  "emailAddress": "pina.colada@wia.io",
  "isAdmin": false,
  "teams": [
    { … }
  ]
}

List users of an organisation

Request

List users of an organisation

Security
Organisation
Query
limitinteger(int32)

Max number of rows to return

Example: limit=20
pageinteger(int32)

Section of rows to return e.g. 0, 1 or 2

sortstring

Sort by Ascending or Descending order Default: DESC

Enum"ASC""DESC"
orderstring

Order by column e.g. id

curl -i -X GET \
  'https://docs.wia.io/_mock/apis/wia-user-management-api/swaggerforusermanagement/organisations/users?limit=20&page=0&sort=ASC&order=string' \
  -H 'Authorization: Bearer <YOUR_Bearer_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idstring
Example: "ou_abc123def"
firstNamestring
Example: "Pina"
lastNamestring
Example: "Colada"
fullNamestring
Example: "Pina Colada"
userIdstring
Example: "usr_abc123def"
emailAddressstring
Example: "pina.colada@wia.io"
isAdminboolean
Example: false
teamsArray of objects(Team)
]
Response
application/json
[
  {
    "id": "ou_abc123def",
    "firstName": "Pina",
    "lastName": "Colada",
    "fullName": "Pina Colada",
    "userId": "usr_abc123def",
    "emailAddress": "pina.colada@wia.io",
    "isAdmin": false,
    "teams": [ … ]
  }
]

Retrieves organisation user with associated teams.

Request

Retrieves organisation user with associated teams.

Security
Organisation
Path
organisationUserIdstringrequired

Id of the organisation user

curl -i -X GET \
  'https://docs.wia.io/_mock/apis/wia-user-management-api/swaggerforusermanagement/organisations/{organisationUserId}' \
  -H 'Authorization: Bearer <YOUR_Bearer_HERE>'

Responses

OK

Bodyapplication/json
idstring
Example: "ou_abc123def"
firstNamestring
Example: "Pina"
lastNamestring
Example: "Colada"
fullNamestring
Example: "Pina Colada"
userIdstring
Example: "usr_abc123def"
emailAddressstring
Example: "pina.colada@wia.io"
isAdminboolean
Example: false
teamsArray of objects(Team)
Response
application/json
{
  "id": "ou_abc123def",
  "firstName": "Pina",
  "lastName": "Colada",
  "fullName": "Pina Colada",
  "userId": "usr_abc123def",
  "emailAddress": "pina.colada@wia.io",
  "isAdmin": false,
  "teams": [
    { … }
  ]
}

Updates details of an organisation user

Request

Updates details of an organisation user

Security
Organisation
Path
organisationUserIdstringrequired

Id of the organisation user to update

Bodyapplication/json
isAdminboolean

Update whether an organisation User is an Admin

curl -i -X PUT \
  'https://docs.wia.io/_mock/apis/wia-user-management-api/swaggerforusermanagement/organisations/users/{organisationUserId}' \
  -H 'Authorization: Bearer <YOUR_Bearer_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "isAdmin": true
  }'

Responses

Organisation user updated successfully

Bodyapplication/json
idstring
Example: "ou_abc123def"
firstNamestring
Example: "Pina"
lastNamestring
Example: "Colada"
fullNamestring
Example: "Pina Colada"
userIdstring
Example: "usr_abc123def"
emailAddressstring
Example: "pina.colada@wia.io"
isAdminboolean
Example: false
teamsArray of objects(Team)
Response
application/json
{
  "id": "ou_abc123def",
  "firstName": "Pina",
  "lastName": "Colada",
  "fullName": "Pina Colada",
  "userId": "usr_abc123def",
  "emailAddress": "pina.colada@wia.io",
  "isAdmin": false,
  "teams": [
    { … }
  ]
}

Remove a user from an organisation and delete the

Request

Remove a user from an organisation and delete the user

Security
Organisation
curl -i -X DELETE \
  'https://docs.wia.io/_mock/apis/wia-user-management-api/swaggerforusermanagement/organisations/users/{organisationUserId}' \
  -H 'Authorization: Bearer <YOUR_Bearer_HERE>'

Responses

User successfully removed

Bodyapplication/json
removedboolean
Example: true
Response
application/json
{
  "removed": true
}

Team

Endpoints focused on team management, including creating teams, managing members, and related operations.

Operations

Space

Endpoints related to Spaces, including retrieval and management of space-specific settings and alerts.

Operations