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

Generate access token

Request

Generate access token

Bodyapplication/json
clientIdstring

The client Id of the organisation

clientSecretstring

The client secret of the organisation

refreshTokenstring

Required for refresh token

grantTypestring

Define the type of grant

Enum"client_credentials""refresh_token"
scopestring

Define the access scope

Value"organisation"
curl -i -X POST \
  https://docs.wia.io/_mock/apis/wia-user-management-api/swaggerforusermanagement/auth/token \
  -H 'Content-Type: application/json' \
  -d '{
    "clientId": "string",
    "clientSecret": "string",
    "refreshToken": "string",
    "grantType": "client_credentials",
    "scope": "organisation"
  }'

Responses

OK

Bodyapplication/json
tokenstring
Example: "u_at_abc123def45678"
refreshTokenstring
Example: "u_rt_abc123def45678"
scopestring

The Domain of the Access Token.

Example: "user"
expiresIninteger
Example: 36000
createdAtinteger
Example: 1642759067045
Response
application/json
{
  "token": "u_at_abc123def45678",
  "refreshToken": "u_rt_abc123def45678",
  "scope": "user",
  "expiresIn": 36000,
  "createdAt": 1642759067045
}

Revoke Token

Request

Revoke Token

Security
Organisation
Bodyapplication/json
tokenstringrequired

The token to revoke

curl -i -X POST \
  https://docs.wia.io/_mock/apis/wia-user-management-api/swaggerforusermanagement/auth/token/revoke \
  -H 'Authorization: Bearer <YOUR_Bearer_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "token": "string"
  }'

Responses

OK

Bodyapplication/json
revokedboolean
Example: true
Response
application/json
{
  "revoked": true
}

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