---
updatedAt: 2026-07-10T17:07:49.000Z
---

# Create the user using SCIM protocol

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "BeyondTrust PM Cloud Management API - Version 1",
    "description": "BeyondTrust PM Cloud Management API - Version 1",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://{example.com}/management-api"
    }
  ],
  "paths": {
    "/scim/v1/users": {
      "post": {
        "tags": [
          "ScimUsers"
        ],
        "summary": "Create the user using SCIM protocol",
        "requestBody": {
          "description": "Is the input model to the method",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/ScimUserModel"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/ScimUserModel"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/ScimUserModel"
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created"
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "409": {
            "description": "Conflict",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ProblemDetails"
                }
              }
            }
          },
          "500": {
            "description": "Server Error"
          }
        },
        "security": [
          {
            "bearer": [],
            "oauth2": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "nullable": true
          },
          "title": {
            "type": "string",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": {}
      },
      "RoleElement": {
        "type": "object",
        "properties": {
          "primary": {
            "type": "boolean",
            "description": "boolena flag for whether or not this is the primary role"
          },
          "value": {
            "type": "string",
            "description": "User role value",
            "nullable": true
          },
          "type": {
            "type": "string",
            "description": "Indicates which type of role is",
            "nullable": true
          }
        },
        "additionalProperties": false,
        "description": "role object"
      },
      "SCIMEmail": {
        "type": "object",
        "properties": {
          "primary": {
            "type": "boolean"
          },
          "value": {
            "type": "string",
            "nullable": true
          },
          "type": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "SCIMUserName": {
        "type": "object",
        "properties": {
          "givenName": {
            "type": "string",
            "nullable": true
          },
          "familyName": {
            "type": "string",
            "nullable": true
          },
          "middleName": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "ScimUserMetaModel": {
        "type": "object",
        "properties": {
          "resourceType": {
            "type": "string",
            "description": "scim resource type",
            "nullable": true
          },
          "created": {
            "type": "string",
            "description": "created date\r\nwill not write to response if using default value",
            "format": "date-time"
          }
        },
        "additionalProperties": false,
        "description": "scim user meta data"
      },
      "ScimUserModel": {
        "type": "object",
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true,
            "readOnly": true
          },
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "userName": {
            "type": "string",
            "nullable": true
          },
          "name": {
            "$ref": "#/components/schemas/SCIMUserName"
          },
          "emails": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SCIMEmail"
            },
            "nullable": true
          },
          "displayName": {
            "type": "string",
            "nullable": true
          },
          "locale": {
            "type": "string",
            "nullable": true
          },
          "timezone": {
            "type": "string",
            "nullable": true
          },
          "externalId": {
            "type": "string",
            "nullable": true
          },
          "dateTimeFormat": {
            "type": "string",
            "nullable": true
          },
          "groups": {
            "type": "array",
            "items": {},
            "nullable": true
          },
          "password": {
            "type": "string",
            "nullable": true
          },
          "active": {
            "type": "boolean",
            "description": "boolean flag of whether or not a user is active",
            "nullable": true
          },
          "roles": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RoleElement"
            },
            "description": "A complex role object for scim",
            "nullable": true
          },
          "entitlements": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RoleElement"
            },
            "description": "A complex role object for scim",
            "nullable": true
          },
          "meta": {
            "$ref": "#/components/schemas/ScimUserMetaModel"
          }
        },
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "bearer": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://sneakpeek-services.epm.bt3ng.com/oauth/connect/token",
            "scopes": {
              "urn:management:api": "Management API scope"
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```