Creates the given user schema. If the upsert query param is set to true then, instead of performing a create, the API will switch to performing an upsert. For an upsert request, the following fields are required:
Required Upsert Fields:
ownerTypeownerId
When performing an upsert, the above fields will be used to determine whether the user schema already exists. If the user schema already exists, a partial update will be performed; otherwise, a new user schema will be created.
In the response of an upsert request, if a create was performed, then a 201 response code will be returned; otherwise, if an update was performed, then a 200 will be returned.
Required Permissions
Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.
| Permission | Boundary | Description |
|---|---|---|
| user-schema:write | Application | The subject can create user schemas within the application to which the subject belongs. |
| Tenant | The subject can create user schemas associated with the tenant to which the subject belongs. | |
| Tenant Inclusion List | The subject can create user schemas for tenants specified in the tenant inclusion list. | |
| Tenant Exclusion List | The subject can create user schemas for tenants in the subject's application that are not on the tenant exclusion list. |