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

Retrieves the details of a specific team using its

Request

Retrieves the details of a specific team using its Id.

Security
Organisation
Path
idstringrequired

Id of the team to retrieve.

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

Responses

Team retrieved successfully.

Bodyapplication/json
idstring
Example: "tem_123abc456def"
namestring
Example: "Test organisation"
isAdminboolean
Example: false
membersArray of objects(TeamMember)
Response
application/json
{
  "id": "tem_123abc456def",
  "name": "Test organisation",
  "isAdmin": false,
  "members": [
    { … }
  ]
}

Deletes a team by its Id.

Request

Deletes a team by its Id.

Security
Organisation
Path
idstringrequired

Id of the team to be deleted.

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

Responses

Team deleted successfully.

Bodyapplication/json
deletedboolean

Indicates whether the deletion was successful.

Example: true
Response
application/json
{
  "deleted": true
}

Retrieves a list of all teams in an organisation.

Request

Retrieves a list of all teams in an organisation.

Security
Organisation
Query
limitinteger

Max number of results per page.

pageinteger

Page number for pagination.

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

Responses

List of teams retrieved successfully.

Bodyapplication/jsonArray [
idstring
Example: "tem_123abc456def"
namestring
Example: "Test organisation"
isAdminboolean
Example: false
membersArray of objects(TeamMember)
]
Response
application/json
[
  {
    "id": "tem_123abc456def",
    "name": "Test organisation",
    "isAdmin": false,
    "members": [ … ]
  }
]

Creates a new team in an organisation.

Request

Creates a new team in an organisation.

Security
Organisation
Bodyapplication/jsonrequired
organisationIdstring

Public Id of the organisation.

Example: "org123"
namestring

Name of the team to create.

Example: "Marketing Team"
curl -i -X POST \
  https://docs.wia.io/_mock/apis/wia-user-management-api/swaggerforusermanagement/teams/ \
  -H 'Authorization: Bearer <YOUR_Bearer_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "organisationId": "org123",
    "name": "Marketing Team"
  }'

Responses

Team created successfully.

Bodyapplication/json
idstring
Example: "tem_123abc456def"
namestring
Example: "Test organisation"
isAdminboolean
Example: false
membersArray of objects(TeamMember)
Response
application/json
{
  "id": "tem_123abc456def",
  "name": "Test organisation",
  "isAdmin": false,
  "members": [
    { … }
  ]
}

Adds a member to a specific team.

Request

Adds a member to a specific team.

Security
Organisation
Path
publicIdstringrequired

Id of the team.

Bodyapplication/jsonrequired
organisationUserIdstring

Id of the organisation User to add as a member.

Example: "ou_123abcder"
curl -i -X POST \
  'https://docs.wia.io/_mock/apis/wia-user-management-api/swaggerforusermanagement/teams/{id}/members' \
  -H 'Authorization: Bearer <YOUR_Bearer_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "organisationUserId": "ou_123abcder"
  }'

Responses

OK

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

Removes member from a specific team.

Request

Removes member from a specific team.

Security
Organisation
Path
publicIdstringrequired

Id of the team.

Bodyapplication/jsonrequired
organisationUserIdstring

Id of the user to remove as a member.

Example: "ou_123abcder"
curl -i -X DELETE \
  'https://docs.wia.io/_mock/apis/wia-user-management-api/swaggerforusermanagement/teams/{id}/members' \
  -H 'Authorization: Bearer <YOUR_Bearer_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "organisationUserId": "ou_123abcder"
  }'

Responses

OK

Bodyapplication/json
deletedboolean
Example: true
Response
application/json
{
  "deleted": true
}

Removes a specific member from a team.

Request

Removes a specific member from a team.

Security
Organisation
Path
idstringrequired

Public Id of the team.

organisationUserIdstringrequired

Id of the organisation user to remove.

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

Responses

Member removed successfully.

Space

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

Operations