### GET /scim/{connection_id}/users

Source: https://api.unified.to/docs/openapi-scim.json

API endpoint for GET /scim/{connection_id}/users

```markdown
### Parameters

- **filter** (string, query, optional)
- **sortBy** (string, query, optional)
- **sortOrder** (string, query, optional)
- **startIndex** (number, query, optional)
- **count** (number, query, optional)
- **connection_id** (string, path, required): ID of the connection

### Responses

#### 200 - Successful

**ScimUsers**
- Array of ScimUser

### Example Usage

```bash
curl -X GET "https://api.unified.to/scim/{connection_id}/users?filter=string&sortBy=string&sortOrder=string&startIndex=0&count=0"
```

```

--------------------------------

### GET /scim/{connection_id}/users/{id}

Source: https://api.unified.to/docs/openapi-scim.json

API endpoint for GET /scim/{connection_id}/users/{id}

```markdown
### Parameters

- **connection_id** (string, path, required): ID of the connection
- **id** (string, path, required): ID of the User

### Responses

#### 200 - Successful

**ScimUser**
- **id** (string)
- **schemas** (array (string (urn:ietf:params:scim:schemas:core:2.0:User|urn:ietf:params:scim:schemas:extension:enterprise:2.0:User|urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User|urn:ietf:params:scim:schemas:extension:peakon:2.0:User)))
- **externalId** (string)
- **userType** (string)
- **userName** (string)
- **meta** (object)
  - **resourceType** (string (User|Group)) ("User"|"Group")
  - **created** (string)
  - **lastModified** (string)
  - **location** (string)
  - **version** (string)
- **name** (object)
  - **formatted** (string)
  - **familyName** (string)
  - **givenName** (string)
  - **middleName** (string)
  - **honorificPrefix** (string)
  - **honorificSuffix** (string)
- **displayName** (string)
- **nickName** (string)
- **profileUrl** (string)
- **title** (string)
- **preferredLanguage** (string)
- **locale** (string)
- **timezone** (string)
- **active** (boolean)
- **password** (string)
- **phoneNumbers** (array (ScimPhoneNumber))
  Array items:
    - **type** (string (work|home|other|mobile|fax|pager)) ("work"|"home"|"other"|"mobile"|"fax"|"pager")
    - **value** (string)
    - **display** (string)
    - **primary** (boolean)
- **emails** (array (ScimEmail))
  Array items:
    - **type** (string (work|home|other)) (required) ("work"|"home"|"other")
    - **value** (string)
    - **primary** (boolean)
    - **display** (string)
- **ims** (array (ScimIms))
  Array items:
- **photos** (array (ScimPhoto))
  Array items:
    - **value** (string)
    - **display** (string)
    - **type** (string (photo|thumbnail)) ("photo"|"thumbnail")
    - **primary** (boolean)
- **addresses** (array (ScimAddress))
  Array items:
    - **formatted** (string)
    - **streetAddress** (string)
    - **locality** (string)
    - **region** (string)
    - **postalCode** (string)
    - **country** (string)
    - **type** (string (work|home|other)) ("work"|"home"|"other")
- **groups** (array (ScimUserGroups))
  Array items:
    - **value** (string) (required)
    - **$ref** (string)
    - **display** (string)
    - **type** (string (direct|indirect)) ("direct"|"indirect")
- **entitlements** (array (ScimEntitlement))
  Array items:
- **roles** (array (ScimRole)): Student, Faculty, ...
  Array items:
- **x509Certificates** (array (ScimRole))
  Array items:
- **urn:ietf:params:scim:schemas:extension:enterprise:2.0:User** (object): an organization.
  - **employeeNumber** (string)
  - **costCenter** (string)
  - **organization** (string)
  - **division** (string)
  - **department** (string)
  - **manager** (object): "id" attribute of another User.
    - **value** (string)
    - **managerId** (string)
    - **$ref** (string)
    - **displayName** (string)
    - **type** (string (direct|indirect)) ("direct"|"indirect")
  - **additionalManagers** (array (ScimManager))
    Array items:
  - **level** (string)
  - **startDate** (string (date-time))
  - **endDate** (string (date-time))
  - **birthday** (string (date-time))
  - **gender** (string (male|female)) ("male"|"female")
  - **location** (string)
- **urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User** (object)
  - **startDate** (string (date-time))
  - **birthDate** (string (date-time))
  - **gender** (string (male|female)) ("male"|"female")
  - **sexualOrientation** (string (Queer|Heterosexual|Straight)) ("Queer"|"Heterosexual"|"Straight")
  - **ethnicity** (string (Caucasian|East Asian|Middle Eastern|Black|Biracial (South Asian & Caucasian)|Filipino|South Asian|Indian|White|Asian)) ("Caucasian"|"East Asian"|"Middle Eastern"|"Black"|"Biracial (South Asian & Caucasian)"|"Filipino"|"South Asian"|"Indian"|"White"|"Asian")
  - **People Manager (Reviews)** (string)
  - **Salary Information** (string)
  - **Remote Work - Location** (string)
  - **Job Level** (string)
  - **Sub Departments** (string)
- **urn:ietf:params:scim:schemas:extension:peakon:2.0:User** (object)
  - **Gender** (string (Female|Male)) ("Female"|"Male")
  - **Team** (string)
  - **Manager** (string)
  - **Date of Birth** (string (date-time))

### Example Usage

```bash
curl -X GET "https://api.unified.to/scim/{connection_id}/users/{id}"
```

```

--------------------------------

### GET /scim/{connection_id}/groups

Source: https://api.unified.to/docs/openapi-scim.json

API endpoint for GET /scim/{connection_id}/groups

```markdown
### Parameters

- **filter** (string, query, optional)
- **sortBy** (string, query, optional)
- **sortOrder** (string, query, optional)
- **startIndex** (number, query, optional)
- **count** (number, query, optional)
- **connection_id** (string, path, required): ID of the connection

### Responses

#### 200 - Successful

**ScimGroups**
- Array of ScimGroup

### Example Usage

```bash
curl -X GET "https://api.unified.to/scim/{connection_id}/groups?filter=string&sortBy=string&sortOrder=string&startIndex=0&count=0"
```

```

--------------------------------

### GET /scim/{connection_id}/groups/{id}

Source: https://api.unified.to/docs/openapi-scim.json

API endpoint for GET /scim/{connection_id}/groups/{id}

```markdown
### Parameters

- **connection_id** (string, path, required): ID of the connection
- **id** (string, path, required): ID of the Group

### Responses

#### 200 - Successful

**ScimGroup**
- **id** (string)
- **externalId** (string)
- **displayName** (string) (required)
- **groupType** (string)
- **members** (array (ScimGroupMember)): An array of members
  Array items:
    - **value** (string) (required)
    - **$ref** (string)
    - **display** (string)
    - **type** (string (User|Group)) ("User"|"Group")
    - **operation** (string (add|delete)) ("add"|"delete")
- **meta** (object)
  - **resourceType** (string (User|Group)) ("User"|"Group")
  - **created** (string)
  - **lastModified** (string)
  - **location** (string)
  - **version** (string)
- **schemas** (array (string (urn:ietf:params:scim:schemas:core:2.0:Group))): Array of schema URIs

### Example Usage

```bash
curl -X GET "https://api.unified.to/scim/{connection_id}/groups/{id}"
```

```

--------------------------------

### POST /scim/{connection_id}/users

Source: https://api.unified.to/docs/openapi-scim.json

API endpoint for POST /scim/{connection_id}/users

```markdown
### Parameters

- **filter** (string, query, optional)
- **sortBy** (string, query, optional)
- **sortOrder** (string, query, optional)
- **startIndex** (number, query, optional)
- **count** (number, query, optional)
- **connection_id** (string, path, required): ID of the connection

### Request Body

**Content-Type:** application/json

- **id** (string)
- **schemas** (array (string (urn:ietf:params:scim:schemas:core:2.0:User|urn:ietf:params:scim:schemas:extension:enterprise:2.0:User|urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User|urn:ietf:params:scim:schemas:extension:peakon:2.0:User)))
- **externalId** (string)
- **userType** (string)
- **userName** (string)
- **meta** (object)
  - **resourceType** (string (User|Group)) ("User"|"Group")
  - **created** (string)
  - **lastModified** (string)
  - **location** (string)
  - **version** (string)
- **name** (object)
  - **formatted** (string)
  - **familyName** (string)
  - **givenName** (string)
  - **middleName** (string)
  - **honorificPrefix** (string)
  - **honorificSuffix** (string)
- **displayName** (string)
- **nickName** (string)
- **profileUrl** (string)
- **title** (string)
- **preferredLanguage** (string)
- **locale** (string)
- **timezone** (string)
- **active** (boolean)
- **password** (string)
- **phoneNumbers** (array (ScimPhoneNumber))
  Array items:
    - **type** (string (work|home|other|mobile|fax|pager)) ("work"|"home"|"other"|"mobile"|"fax"|"pager")
    - **value** (string)
    - **display** (string)
    - **primary** (boolean)
- **emails** (array (ScimEmail))
  Array items:
    - **type** (string (work|home|other)) (required) ("work"|"home"|"other")
    - **value** (string)
    - **primary** (boolean)
    - **display** (string)
- **ims** (array (ScimIms))
  Array items:
- **photos** (array (ScimPhoto))
  Array items:
    - **value** (string)
    - **display** (string)
    - **type** (string (photo|thumbnail)) ("photo"|"thumbnail")
    - **primary** (boolean)
- **addresses** (array (ScimAddress))
  Array items:
    - **formatted** (string)
    - **streetAddress** (string)
    - **locality** (string)
    - **region** (string)
    - **postalCode** (string)
    - **country** (string)
    - **type** (string (work|home|other)) ("work"|"home"|"other")
- **groups** (array (ScimUserGroups))
  Array items:
    - **value** (string) (required)
    - **$ref** (string)
    - **display** (string)
    - **type** (string (direct|indirect)) ("direct"|"indirect")
- **entitlements** (array (ScimEntitlement))
  Array items:
- **roles** (array (ScimRole)): Student, Faculty, ...
  Array items:
- **x509Certificates** (array (ScimRole))
  Array items:
- **urn:ietf:params:scim:schemas:extension:enterprise:2.0:User** (object): an organization.
  - **employeeNumber** (string)
  - **costCenter** (string)
  - **organization** (string)
  - **division** (string)
  - **department** (string)
  - **manager** (object): "id" attribute of another User.
    - **value** (string)
    - **managerId** (string)
    - **$ref** (string)
    - **displayName** (string)
    - **type** (string (direct|indirect)) ("direct"|"indirect")
  - **additionalManagers** (array (ScimManager))
    Array items:
  - **level** (string)
  - **startDate** (string (date-time))
  - **endDate** (string (date-time))
  - **birthday** (string (date-time))
  - **gender** (string (male|female)) ("male"|"female")
  - **location** (string)
- **urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User** (object)
  - **startDate** (string (date-time))
  - **birthDate** (string (date-time))
  - **gender** (string (male|female)) ("male"|"female")
  - **sexualOrientation** (string (Queer|Heterosexual|Straight)) ("Queer"|"Heterosexual"|"Straight")
  - **ethnicity** (string (Caucasian|East Asian|Middle Eastern|Black|Biracial (South Asian & Caucasian)|Filipino|South Asian|Indian|White|Asian)) ("Caucasian"|"East Asian"|"Middle Eastern"|"Black"|"Biracial (South Asian & Caucasian)"|"Filipino"|"South Asian"|"Indian"|"White"|"Asian")
  - **People Manager (Reviews)** (string)
  - **Salary Information** (string)
  - **Remote Work - Location** (string)
  - **Job Level** (string)
  - **Sub Departments** (string)
- **urn:ietf:params:scim:schemas:extension:peakon:2.0:User** (object)
  - **Gender** (string (Female|Male)) ("Female"|"Male")
  - **Team** (string)
  - **Manager** (string)
  - **Date of Birth** (string (date-time))

### Responses

#### 200 - Successful

**ScimUser**
- **id** (string)
- **schemas** (array (string (urn:ietf:params:scim:schemas:core:2.0:User|urn:ietf:params:scim:schemas:extension:enterprise:2.0:User|urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User|urn:ietf:params:scim:schemas:extension:peakon:2.0:User)))
- **externalId** (string)
- **userType** (string)
- **userName** (string)
- **meta** (object)
  - **resourceType** (string (User|Group)) ("User"|"Group")
  - **created** (string)
  - **lastModified** (string)
  - **location** (string)
  - **version** (string)
- **name** (object)
  - **formatted** (string)
  - **familyName** (string)
  - **givenName** (string)
  - **middleName** (string)
  - **honorificPrefix** (string)
  - **honorificSuffix** (string)
- **displayName** (string)
- **nickName** (string)
- **profileUrl** (string)
- **title** (string)
- **preferredLanguage** (string)
- **locale** (string)
- **timezone** (string)
- **active** (boolean)
- **password** (string)
- **phoneNumbers** (array (ScimPhoneNumber))
  Array items:
    - **type** (string (work|home|other|mobile|fax|pager)) ("work"|"home"|"other"|"mobile"|"fax"|"pager")
    - **value** (string)
    - **display** (string)
    - **primary** (boolean)
- **emails** (array (ScimEmail))
  Array items:
    - **type** (string (work|home|other)) (required) ("work"|"home"|"other")
    - **value** (string)
    - **primary** (boolean)
    - **display** (string)
- **ims** (array (ScimIms))
  Array items:
- **photos** (array (ScimPhoto))
  Array items:
    - **value** (string)
    - **display** (string)
    - **type** (string (photo|thumbnail)) ("photo"|"thumbnail")
    - **primary** (boolean)
- **addresses** (array (ScimAddress))
  Array items:
    - **formatted** (string)
    - **streetAddress** (string)
    - **locality** (string)
    - **region** (string)
    - **postalCode** (string)
    - **country** (string)
    - **type** (string (work|home|other)) ("work"|"home"|"other")
- **groups** (array (ScimUserGroups))
  Array items:
    - **value** (string) (required)
    - **$ref** (string)
    - **display** (string)
    - **type** (string (direct|indirect)) ("direct"|"indirect")
- **entitlements** (array (ScimEntitlement))
  Array items:
- **roles** (array (ScimRole)): Student, Faculty, ...
  Array items:
- **x509Certificates** (array (ScimRole))
  Array items:
- **urn:ietf:params:scim:schemas:extension:enterprise:2.0:User** (object): an organization.
  - **employeeNumber** (string)
  - **costCenter** (string)
  - **organization** (string)
  - **division** (string)
  - **department** (string)
  - **manager** (object): "id" attribute of another User.
    - **value** (string)
    - **managerId** (string)
    - **$ref** (string)
    - **displayName** (string)
    - **type** (string (direct|indirect)) ("direct"|"indirect")
  - **additionalManagers** (array (ScimManager))
    Array items:
  - **level** (string)
  - **startDate** (string (date-time))
  - **endDate** (string (date-time))
  - **birthday** (string (date-time))
  - **gender** (string (male|female)) ("male"|"female")
  - **location** (string)
- **urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User** (object)
  - **startDate** (string (date-time))
  - **birthDate** (string (date-time))
  - **gender** (string (male|female)) ("male"|"female")
  - **sexualOrientation** (string (Queer|Heterosexual|Straight)) ("Queer"|"Heterosexual"|"Straight")
  - **ethnicity** (string (Caucasian|East Asian|Middle Eastern|Black|Biracial (South Asian & Caucasian)|Filipino|South Asian|Indian|White|Asian)) ("Caucasian"|"East Asian"|"Middle Eastern"|"Black"|"Biracial (South Asian & Caucasian)"|"Filipino"|"South Asian"|"Indian"|"White"|"Asian")
  - **People Manager (Reviews)** (string)
  - **Salary Information** (string)
  - **Remote Work - Location** (string)
  - **Job Level** (string)
  - **Sub Departments** (string)
- **urn:ietf:params:scim:schemas:extension:peakon:2.0:User** (object)
  - **Gender** (string (Female|Male)) ("Female"|"Male")
  - **Team** (string)
  - **Manager** (string)
  - **Date of Birth** (string (date-time))

### Example Usage

```bash
curl -X POST "https://api.unified.to/scim/{connection_id}/users?filter=string&sortBy=string&sortOrder=string&startIndex=0&count=0" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "string",
  "schemas": "value",
  "externalId": "string",
  "userType": "string",
  "userName": "string",
  "meta": "value",
  "name": "value",
  "displayName": "string",
  "nickName": "string",
  "profileUrl": "string",
  "title": "string",
  "preferredLanguage": "string",
  "locale": "string",
  "timezone": "string",
  "active": "true",
  "password": "string",
  "phoneNumbers": "value",
  "emails": "value",
  "ims": "value",
  "photos": "value",
  "addresses": "value",
  "groups": "value",
  "entitlements": "value",
  "roles": "value",
  "x509Certificates": "value",
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": "value",
  "urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User": "value",
  "urn:ietf:params:scim:schemas:extension:peakon:2.0:User": "value"
}'
```

```

--------------------------------

### API Overview: Unified.to SCIM API

Source: https://api.unified.to/docs/openapi-scim.json

One API to Rule Them All

```yaml
# Unified.to SCIM API
# Version: 1.0

One API to Rule Them All

# Base URL: https://api.unified.to
```

--------------------------------

### Schema: property_ScimUser_roles

Source: https://api.unified.to/docs/openapi-scim.json

Student, Faculty, ...

```markdown
## Schema: property_ScimUser_roles

Student, Faculty, ...

**Type:** array

- Array of ScimRole

```

--------------------------------

### Schema: ScimRole

Source: https://api.unified.to/docs/openapi-scim.json

Schema definition for ScimRole

```markdown
## Schema: ScimRole

Schema definition for ScimRole

**Type:** object

- **value** (string) (required)
- **display** (string)
- **type** (string)
- **primary** (boolean)

```

--------------------------------

### POST /scim/{connection_id}/groups

Source: https://api.unified.to/docs/openapi-scim.json

API endpoint for POST /scim/{connection_id}/groups

```markdown
### Parameters

- **connection_id** (string, path, required): ID of the connection

### Request Body

**Content-Type:** application/json

- **id** (string)
- **externalId** (string)
- **displayName** (string) (required)
- **groupType** (string)
- **members** (array (ScimGroupMember)): An array of members
  Array items:
    - **value** (string) (required)
    - **$ref** (string)
    - **display** (string)
    - **type** (string (User|Group)) ("User"|"Group")
    - **operation** (string (add|delete)) ("add"|"delete")
- **meta** (object)
  - **resourceType** (string (User|Group)) ("User"|"Group")
  - **created** (string)
  - **lastModified** (string)
  - **location** (string)
  - **version** (string)
- **schemas** (array (string (urn:ietf:params:scim:schemas:core:2.0:Group))): Array of schema URIs

### Responses

#### 200 - Successful

**ScimGroup**
- **id** (string)
- **externalId** (string)
- **displayName** (string) (required)
- **groupType** (string)
- **members** (array (ScimGroupMember)): An array of members
  Array items:
    - **value** (string) (required)
    - **$ref** (string)
    - **display** (string)
    - **type** (string (User|Group)) ("User"|"Group")
    - **operation** (string (add|delete)) ("add"|"delete")
- **meta** (object)
  - **resourceType** (string (User|Group)) ("User"|"Group")
  - **created** (string)
  - **lastModified** (string)
  - **location** (string)
  - **version** (string)
- **schemas** (array (string (urn:ietf:params:scim:schemas:core:2.0:Group))): Array of schema URIs

### Example Usage

```bash
curl -X POST "https://api.unified.to/scim/{connection_id}/groups" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "string",
  "externalId": "string",
  "displayName": "string",
  "groupType": "string",
  "members": "value",
  "meta": "value",
  "schemas": "value"
}'
```

```

--------------------------------

### Schema: ScimPhoto

Source: https://api.unified.to/docs/openapi-scim.json

Schema definition for ScimPhoto

```markdown
## Schema: ScimPhoto

Schema definition for ScimPhoto

**Type:** object

- **value** (string)
- **display** (string)
- **type** (string (photo|thumbnail)) ("photo"|"thumbnail")
- **primary** (boolean)

```

--------------------------------

### Security: authorization

Source: https://api.unified.to/docs/openapi-scim.json

Security scheme: jwt

```markdown
## Security: authorization

**Description:** Security scheme: jwt

**Type:** apiKey


```

--------------------------------

### Schema: property_ScimGroup_schemas

Source: https://api.unified.to/docs/openapi-scim.json

Array of schema URIs

```markdown
## Schema: property_ScimGroup_schemas

Array of schema URIs

**Type:** array

- Array of string (urn:ietf:params:scim:schemas:core:2.0:Group)

```

--------------------------------

### PUT /scim/{connection_id}/users/{id}

Source: https://api.unified.to/docs/openapi-scim.json

API endpoint for PUT /scim/{connection_id}/users/{id}

```markdown
### Parameters

- **connection_id** (string, path, required): ID of the connection
- **id** (string, path, required): ID of the User

### Request Body

**Content-Type:** application/json

- **id** (string)
- **schemas** (array (string (urn:ietf:params:scim:schemas:core:2.0:User|urn:ietf:params:scim:schemas:extension:enterprise:2.0:User|urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User|urn:ietf:params:scim:schemas:extension:peakon:2.0:User)))
- **externalId** (string)
- **userType** (string)
- **userName** (string)
- **meta** (object)
  - **resourceType** (string (User|Group)) ("User"|"Group")
  - **created** (string)
  - **lastModified** (string)
  - **location** (string)
  - **version** (string)
- **name** (object)
  - **formatted** (string)
  - **familyName** (string)
  - **givenName** (string)
  - **middleName** (string)
  - **honorificPrefix** (string)
  - **honorificSuffix** (string)
- **displayName** (string)
- **nickName** (string)
- **profileUrl** (string)
- **title** (string)
- **preferredLanguage** (string)
- **locale** (string)
- **timezone** (string)
- **active** (boolean)
- **password** (string)
- **phoneNumbers** (array (ScimPhoneNumber))
  Array items:
    - **type** (string (work|home|other|mobile|fax|pager)) ("work"|"home"|"other"|"mobile"|"fax"|"pager")
    - **value** (string)
    - **display** (string)
    - **primary** (boolean)
- **emails** (array (ScimEmail))
  Array items:
    - **type** (string (work|home|other)) (required) ("work"|"home"|"other")
    - **value** (string)
    - **primary** (boolean)
    - **display** (string)
- **ims** (array (ScimIms))
  Array items:
- **photos** (array (ScimPhoto))
  Array items:
    - **value** (string)
    - **display** (string)
    - **type** (string (photo|thumbnail)) ("photo"|"thumbnail")
    - **primary** (boolean)
- **addresses** (array (ScimAddress))
  Array items:
    - **formatted** (string)
    - **streetAddress** (string)
    - **locality** (string)
    - **region** (string)
    - **postalCode** (string)
    - **country** (string)
    - **type** (string (work|home|other)) ("work"|"home"|"other")
- **groups** (array (ScimUserGroups))
  Array items:
    - **value** (string) (required)
    - **$ref** (string)
    - **display** (string)
    - **type** (string (direct|indirect)) ("direct"|"indirect")
- **entitlements** (array (ScimEntitlement))
  Array items:
- **roles** (array (ScimRole)): Student, Faculty, ...
  Array items:
- **x509Certificates** (array (ScimRole))
  Array items:
- **urn:ietf:params:scim:schemas:extension:enterprise:2.0:User** (object): an organization.
  - **employeeNumber** (string)
  - **costCenter** (string)
  - **organization** (string)
  - **division** (string)
  - **department** (string)
  - **manager** (object): "id" attribute of another User.
    - **value** (string)
    - **managerId** (string)
    - **$ref** (string)
    - **displayName** (string)
    - **type** (string (direct|indirect)) ("direct"|"indirect")
  - **additionalManagers** (array (ScimManager))
    Array items:
  - **level** (string)
  - **startDate** (string (date-time))
  - **endDate** (string (date-time))
  - **birthday** (string (date-time))
  - **gender** (string (male|female)) ("male"|"female")
  - **location** (string)
- **urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User** (object)
  - **startDate** (string (date-time))
  - **birthDate** (string (date-time))
  - **gender** (string (male|female)) ("male"|"female")
  - **sexualOrientation** (string (Queer|Heterosexual|Straight)) ("Queer"|"Heterosexual"|"Straight")
  - **ethnicity** (string (Caucasian|East Asian|Middle Eastern|Black|Biracial (South Asian & Caucasian)|Filipino|South Asian|Indian|White|Asian)) ("Caucasian"|"East Asian"|"Middle Eastern"|"Black"|"Biracial (South Asian & Caucasian)"|"Filipino"|"South Asian"|"Indian"|"White"|"Asian")
  - **People Manager (Reviews)** (string)
  - **Salary Information** (string)
  - **Remote Work - Location** (string)
  - **Job Level** (string)
  - **Sub Departments** (string)
- **urn:ietf:params:scim:schemas:extension:peakon:2.0:User** (object)
  - **Gender** (string (Female|Male)) ("Female"|"Male")
  - **Team** (string)
  - **Manager** (string)
  - **Date of Birth** (string (date-time))

### Responses

#### 200 - Successful

**ScimUser**
- **id** (string)
- **schemas** (array (string (urn:ietf:params:scim:schemas:core:2.0:User|urn:ietf:params:scim:schemas:extension:enterprise:2.0:User|urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User|urn:ietf:params:scim:schemas:extension:peakon:2.0:User)))
- **externalId** (string)
- **userType** (string)
- **userName** (string)
- **meta** (object)
  - **resourceType** (string (User|Group)) ("User"|"Group")
  - **created** (string)
  - **lastModified** (string)
  - **location** (string)
  - **version** (string)
- **name** (object)
  - **formatted** (string)
  - **familyName** (string)
  - **givenName** (string)
  - **middleName** (string)
  - **honorificPrefix** (string)
  - **honorificSuffix** (string)
- **displayName** (string)
- **nickName** (string)
- **profileUrl** (string)
- **title** (string)
- **preferredLanguage** (string)
- **locale** (string)
- **timezone** (string)
- **active** (boolean)
- **password** (string)
- **phoneNumbers** (array (ScimPhoneNumber))
  Array items:
    - **type** (string (work|home|other|mobile|fax|pager)) ("work"|"home"|"other"|"mobile"|"fax"|"pager")
    - **value** (string)
    - **display** (string)
    - **primary** (boolean)
- **emails** (array (ScimEmail))
  Array items:
    - **type** (string (work|home|other)) (required) ("work"|"home"|"other")
    - **value** (string)
    - **primary** (boolean)
    - **display** (string)
- **ims** (array (ScimIms))
  Array items:
- **photos** (array (ScimPhoto))
  Array items:
    - **value** (string)
    - **display** (string)
    - **type** (string (photo|thumbnail)) ("photo"|"thumbnail")
    - **primary** (boolean)
- **addresses** (array (ScimAddress))
  Array items:
    - **formatted** (string)
    - **streetAddress** (string)
    - **locality** (string)
    - **region** (string)
    - **postalCode** (string)
    - **country** (string)
    - **type** (string (work|home|other)) ("work"|"home"|"other")
- **groups** (array (ScimUserGroups))
  Array items:
    - **value** (string) (required)
    - **$ref** (string)
    - **display** (string)
    - **type** (string (direct|indirect)) ("direct"|"indirect")
- **entitlements** (array (ScimEntitlement))
  Array items:
- **roles** (array (ScimRole)): Student, Faculty, ...
  Array items:
- **x509Certificates** (array (ScimRole))
  Array items:
- **urn:ietf:params:scim:schemas:extension:enterprise:2.0:User** (object): an organization.
  - **employeeNumber** (string)
  - **costCenter** (string)
  - **organization** (string)
  - **division** (string)
  - **department** (string)
  - **manager** (object): "id" attribute of another User.
    - **value** (string)
    - **managerId** (string)
    - **$ref** (string)
    - **displayName** (string)
    - **type** (string (direct|indirect)) ("direct"|"indirect")
  - **additionalManagers** (array (ScimManager))
    Array items:
  - **level** (string)
  - **startDate** (string (date-time))
  - **endDate** (string (date-time))
  - **birthday** (string (date-time))
  - **gender** (string (male|female)) ("male"|"female")
  - **location** (string)
- **urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User** (object)
  - **startDate** (string (date-time))
  - **birthDate** (string (date-time))
  - **gender** (string (male|female)) ("male"|"female")
  - **sexualOrientation** (string (Queer|Heterosexual|Straight)) ("Queer"|"Heterosexual"|"Straight")
  - **ethnicity** (string (Caucasian|East Asian|Middle Eastern|Black|Biracial (South Asian & Caucasian)|Filipino|South Asian|Indian|White|Asian)) ("Caucasian"|"East Asian"|"Middle Eastern"|"Black"|"Biracial (South Asian & Caucasian)"|"Filipino"|"South Asian"|"Indian"|"White"|"Asian")
  - **People Manager (Reviews)** (string)
  - **Salary Information** (string)
  - **Remote Work - Location** (string)
  - **Job Level** (string)
  - **Sub Departments** (string)
- **urn:ietf:params:scim:schemas:extension:peakon:2.0:User** (object)
  - **Gender** (string (Female|Male)) ("Female"|"Male")
  - **Team** (string)
  - **Manager** (string)
  - **Date of Birth** (string (date-time))

### Example Usage

```bash
curl -X PUT "https://api.unified.to/scim/{connection_id}/users/{id}" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "string",
  "schemas": "value",
  "externalId": "string",
  "userType": "string",
  "userName": "string",
  "meta": "value",
  "name": "value",
  "displayName": "string",
  "nickName": "string",
  "profileUrl": "string",
  "title": "string",
  "preferredLanguage": "string",
  "locale": "string",
  "timezone": "string",
  "active": "true",
  "password": "string",
  "phoneNumbers": "value",
  "emails": "value",
  "ims": "value",
  "photos": "value",
  "addresses": "value",
  "groups": "value",
  "entitlements": "value",
  "roles": "value",
  "x509Certificates": "value",
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": "value",
  "urn:ietf:params:scim:schemas:extension:lattice:attributes:1.0:User": "value",
  "urn:ietf:params:scim:schemas:extension:peakon:2.0:User": "value"
}'
```

```

--------------------------------

### Schema: ScimManager

Source: https://api.unified.to/docs/openapi-scim.json

"id" attribute of another User.

```markdown
## Schema: ScimManager

"id" attribute of another User.

**Type:** object

- **value** (string)
- **managerId** (string)
- **$ref** (string)
- **displayName** (string)
- **type** (string (direct|indirect)) ("direct"|"indirect")

```

--------------------------------

### Schema: ScimEntitlement

Source: https://api.unified.to/docs/openapi-scim.json

Schema definition for ScimEntitlement

```markdown
## Schema: ScimEntitlement

Schema definition for ScimEntitlement

**Type:** object

- **value** (string) (required)
- **display** (string)
- **type** (string)
- **primary** (boolean)

```