Skip to content

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

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

Retrieve list of all Spaces

Request

Retrieve list of all Spaces

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

countrystring^[A-Z]{3}$

ISO 3166-1 alpha-3 country code

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

Responses

OK

Bodyapplication/jsonArray [
idstring
Example: "spc_abc123"
clientIdstring
Example: "client-specific-id"
namestring
Example: "Test Space"
isPublicboolean
Example: false
disabledboolean
Example: false
avatarobject
ownerobject
]
Response
application/json
[
  {
    "id": "spc_abc123",
    "clientId": "client-specific-id",
    "name": "Test Space",
    "isPublic": false,
    "disabled": false,
    "avatar": { … },
    "owner": { … }
  }
]

Add a user to space alerts

Request

Add a user to space alerts

Security
Organisation
Path
organisationUserIdstringrequired

Id of the Organisation User to add to alerts

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

Responses

User successfully added

Bodyapplication/json
addedboolean
Example: true
Response
application/json
{
  "added": true
}

Remove a user from space alerts

Request

Remove a user from space alerts

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

Responses

User successfully removed

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