# Wia REST API User reference

</br>A REST API to interact with Wia platform for user management for external IAM teams. </br> </br> 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.  </br> </br> 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.

Version: v1

## Servers

Production
```
https://api.wia.io/v1
```

## Security

### Organisation

An application accessToken can be used

Type: http
Scheme: bearer
Bearer Format: Bearer

## Download OpenAPI description

[Wia REST API User reference](https://docs.wia.io/_spec/apis/Wia%20User%20Management%20API/swaggerForUserManagement.yaml)

## Auth

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

### Generate access token

 - [POST /auth/token](https://docs.wia.io/apis/wia-user-management-api/swaggerforusermanagement/auth/paths/~1auth~1token/post.md): Generate access token

### Revoke Token

 - [POST /auth/token/revoke](https://docs.wia.io/apis/wia-user-management-api/swaggerforusermanagement/auth/paths/~1auth~1token~1revoke/post.md): Revoke Token

## Organisation

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

### Creates a user and adds them to an organisation

 - [POST /organisations/users/](https://docs.wia.io/apis/wia-user-management-api/swaggerforusermanagement/organisation/paths/~1organisations~1users~1/post.md): Creates a user and adds them to an organisation

### List users of an organisation

 - [GET /organisations/users](https://docs.wia.io/apis/wia-user-management-api/swaggerforusermanagement/organisation/paths/~1organisations~1users/get.md): List users of an organisation

### Retrieves organisation user with associated teams.

 - [GET /organisations/{organisationUserId}](https://docs.wia.io/apis/wia-user-management-api/swaggerforusermanagement/organisation/paths/~1organisations~1%7Borganisationuserid%7D/get.md): Retrieves organisation user with associated teams.

### Updates details of an organisation user

 - [PUT /organisations/users/{organisationUserId}](https://docs.wia.io/apis/wia-user-management-api/swaggerforusermanagement/organisation/paths/~1organisations~1users~1%7Borganisationuserid%7D/put.md): Updates details of an organisation user

### Remove a user from an organisation and delete the 

 - [DELETE /organisations/users/{organisationUserId}](https://docs.wia.io/apis/wia-user-management-api/swaggerforusermanagement/organisation/paths/~1organisations~1users~1%7Borganisationuserid%7D/delete.md): Remove a user from an organisation and delete the user

## Team

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

### Retrieves the details of a specific team using its

 - [GET /teams/{id}](https://docs.wia.io/apis/wia-user-management-api/swaggerforusermanagement/team/paths/~1teams~1%7Bid%7D/get.md): Retrieves the details of a specific team using its Id.

### Deletes a team by its Id.

 - [DELETE /teams/{id}](https://docs.wia.io/apis/wia-user-management-api/swaggerforusermanagement/team/paths/~1teams~1%7Bid%7D/delete.md): Deletes a team by its Id.

### Retrieves a list of all teams in an organisation.

 - [GET /teams/](https://docs.wia.io/apis/wia-user-management-api/swaggerforusermanagement/team/paths/~1teams~1/get.md): Retrieves a list of all teams in an organisation.

### Creates a new team in an organisation.

 - [POST /teams/](https://docs.wia.io/apis/wia-user-management-api/swaggerforusermanagement/team/paths/~1teams~1/post.md): Creates a new team in an organisation.

### Adds a member to a specific team.

 - [POST /teams/{id}/members](https://docs.wia.io/apis/wia-user-management-api/swaggerforusermanagement/team/paths/~1teams~1%7Bid%7D~1members/post.md): Adds a member to a specific team.

### Removes member from a specific team.

 - [DELETE /teams/{id}/members](https://docs.wia.io/apis/wia-user-management-api/swaggerforusermanagement/team/paths/~1teams~1%7Bid%7D~1members/delete.md): Removes member from a specific team.

### Removes a specific member from a team.

 - [DELETE /teams/{id}/members/{organisationUserId}](https://docs.wia.io/apis/wia-user-management-api/swaggerforusermanagement/team/paths/~1teams~1%7Bid%7D~1members~1%7Borganisationuserid%7D/delete.md): Removes a specific member from a team.

## Space

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

### Retrieve list of all Spaces

 - [GET /spaces](https://docs.wia.io/apis/wia-user-management-api/swaggerforusermanagement/space/paths/~1spaces/get.md): Retrieve list of all Spaces

### Add a user to space alerts

 - [POST /spaces/{id}/alerts/users/{organisationUserId}](https://docs.wia.io/apis/wia-user-management-api/swaggerforusermanagement/space/paths/~1spaces~1%7Bid%7D~1alerts~1users~1%7Borganisationuserid%7D/post.md): Add a user to space alerts

### Remove a user from space alerts

 - [DELETE /spaces/{id}/alerts/users/{organisationUserId}](https://docs.wia.io/apis/wia-user-management-api/swaggerforusermanagement/space/paths/~1spaces~1%7Bid%7D~1alerts~1users~1%7Borganisationuserid%7D/delete.md): Remove a user from space alerts