# Users-SCIM

Manage user profiles using SCIM protocol


## Servers

Sandbox environment
```
https://api.sbx.transmitsecurity.io/cis
```

Production environment (US)
```
https://api.transmitsecurity.io/cis
```

Production environment (EU)
```
https://api.eu.transmitsecurity.io/cis
```

Production environment (CA)
```
https://api.ca.transmitsecurity.io/cis
```

Production environment (AU)
```
https://api.au.transmitsecurity.io/cis
```

## Security

### bearer

Type: http
Scheme: bearer
Bearer Format: JWT

### UserAccessToken

A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated

Type: http
Scheme: bearer
Bearer Format: JWT

### AdminAccessToken

A token generated by a management application using the [token endpoint](/openapi/token.openapi/other/getaccesstoken). It provides access to all resources for the tenant and its apps

Type: oauth2

### ClientAccessToken

A token generated by an end-user application using the [token endpoint](/openapi/token.openapi/other/getaccesstoken). It provides access to resources and data on the tenant level or associated with the specific application (but not other apps in the tenant)

Type: oauth2

### OrgAdminAccessToken

A token returned upon B2B authentication for a user that has the organizationAdmin or organizationCreator role.

Type: oauth2

## Download OpenAPI description

[Users-SCIM](https://developer.transmitsecurity.com/_bundle/openapi/user/user-scim.openapi.yaml)

## Other

### Create user

 - [POST /scim/Users](https://developer.transmitsecurity.com/openapi/user/user-scim.openapi/other/scimcreateuser.md): Add a user to Transmit using SCIM protocol. Required permissions: apps:create, [appId]:create, users:create.

### Get scim users

 - [GET /scim/Users](https://developer.transmitsecurity.com/openapi/user/user-scim.openapi/other/scimgetusersgetrequest.md): Search across your application’s users at Transmit. This endpoint also allows you to return all of your application’s users by sending no filters at all. Required permissions: apps:read, [appId]:read, users:read, apps:list, [appId]:list, users:list.

### Get scim users

 - [POST /scim/Users/.search](https://developer.transmitsecurity.com/openapi/user/user-scim.openapi/other/scimgetuserspostrequest.md): Search across your application’s users at Transmit. This endpoint also allows you to return all of your application’s users by sending no filters at all. Required permissions: apps:read, [appId]:read, users:read, apps:list, [appId]:list, users:list.

### Get SCIM user by ID

 - [GET /scim/Users/{user_id}](https://developer.transmitsecurity.com/openapi/user/user-scim.openapi/other/scimgetuserbyid.md): Search for a SCIM user by user ID. Required permissions: apps:read, [appId]:read, users:read.

### Replace user attributes

 - [PUT /scim/Users/{user_id}](https://developer.transmitsecurity.com/openapi/user/user-scim.openapi/other/scimreplaceuserattributes.md): Replace user attributes using SCIM protocol. Required permissions: apps:edit, [appId]:edit, users:edit.

### Delete SCIM user by ID

 - [DELETE /scim/Users/{user_id}](https://developer.transmitsecurity.com/openapi/user/user-scim.openapi/other/scimdeleteuserbyid.md): Delete a user from Transmit using SCIM protocol. Required permissions: apps:delete, [appId]:delete, users:delete.