---
title: "Schemas"
slug: "schemas"
updated: 2024-04-29T11:17:39Z
published: 2024-04-29T11:17:39Z
canonical: "support.perimeter81.com/schemas"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.perimeter81.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Schemas

## Request Headers

Each request must include the following request headers:

| Property | Data Type | Description |
| --- | --- | --- |
| Authorization* | String | Your temporary [Access Token](/v1/docs/authorize) obtained using the /authorize method |
| Content-Type* | <meta charset="utf-8">String | <meta charset="utf-8">*application/json* |

## Request Body Schemas

### User

A user, also known as a Member. Response to [POST /v1/users](https://support.perimeter81.com/docs/api#post-v1users) and [DELETE /v1/users/{id}](https://support.perimeter81.com/docs/api#delete-v1usersid). Found in **UserList**.

| Property | Data Type | Description |
| --- | --- | --- |
| terminated* | Boolean | Whether user is deleted (true). |
| email* | String ($UTF8) | User email. |
| emailVerified* | Boolean | Whether email is verified (true). |
| initials* | String | User initials. |
| roleName* | String | User role. |
| lastName* | String | User last name. |
| firstname* | String | User first name. |
| id* | String | ID of user. |

### UserList

List of users. Response to [GET /v1/users](https://support.perimeter81.com/docs/api#get-v1users).

| Property | Data Type | Description |
| --- | --- | --- |
| data* | Array of User | List of users. |
| page* | Number | Starting page number. |
| totalPage* | Number | Number of pages in list. |
| itemsTotal* | Number | Number of items in list. |

### CreateUserDto

DTO for creating a new member. Request body to /v1/users.

| Property | Data Type | Description |
| --- | --- | --- |
| idpType | String | Type of identity provider. For users created via the API, the value will always be "*database*" Below you can find the available values. |
| accessGroups | Array of String | List of Access Group names to which the new user should be assigned. |
| email* | String ($UTF8) | User’s email address. |
| emailVerified | Boolean | Whether the email is already verified ("*true"*). |
| inviteMessage* | String | The message that will be attached to the invitation email sent to the new user. |
| profileData | ProfileSchema | Profile information: - firstName - lastName - roleName - phone - icon |
| origin | String ($UTF8) | Source. Minimum length of 1. |

### ProfileSchema

Member profile information. Found in **CreateUserDto**.

| Property | Data Type | Description |
| --- | --- | --- |
| firstName | String | First name of user. |
| lastName | String | Last name of user. |
| roleName | String | Name of user's role. |
| phone | String | Telephone. |
| icon | String | User's icon, if any. |

### idpType

Type of the identity provider. Found in **CreateUserDto**.

| Value | Description |
| --- | --- |
| database | Database-based authentication. |
| saml | Security Assertion Markup Language standard for authentication and authorization. |
| gsuite | Google Workspace cloud tool. |
| okta | Okta identity and access management. |
| azureAD | Microsoft Entra ID (formerly Azure Active Directory) authentication. |
| adLdap | PHP class that provides LDAP authentication and integration with Active Directory. |