---
updatedAt: 2026-07-02T14:54:49.000Z
---

# /scim/v2/Roles

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "BeyondTrust PM Cloud Management API - Version 2",
    "description": "BeyondTrust PM Cloud Management API - Version 2",
    "version": "v2"
  },
  "servers": [
    {
      "url": "https://{example.com}/management-api"
    }
  ],
  "paths": {
    "/scim/v2/Roles": {
      "get": {
        "tags": [
          "ScimRoles"
        ],
        "parameters": [
          {
            "name": "filter",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "startIndex",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "count",
            "in": "query",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/scim+json": {
                "schema": {
                  "$ref": "#/components/schemas/ScimUserRoleScimListResponse"
                }
              }
            }
          }
        },
        "security": [
          {
            "bearer": [],
            "oauth2": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "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"
      },
      "ScimUserRole": {
        "type": "object",
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "schema for the role",
            "nullable": true,
            "readOnly": true
          },
          "value": {
            "type": "string",
            "description": "Value of the Role\r\nRequired",
            "nullable": true
          },
          "display": {
            "type": "string",
            "description": "Display name for the role\r\nOptional",
            "nullable": true
          },
          "enabled": {
            "type": "boolean",
            "description": "Required"
          },
          "type": {
            "type": "string",
            "description": "Type",
            "nullable": true
          },
          "meta": {
            "$ref": "#/components/schemas/ScimUserMetaModel"
          }
        },
        "additionalProperties": false,
        "description": "Scim Role"
      },
      "ScimUserRoleScimListResponse": {
        "type": "object",
        "properties": {
          "schemas": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true,
            "readOnly": true
          },
          "totalResults": {
            "type": "integer",
            "format": "int32"
          },
          "startIndex": {
            "type": "integer",
            "format": "int32"
          },
          "itemsPerPage": {
            "type": "integer",
            "format": "int32"
          },
          "Resources": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ScimUserRole"
            },
            "nullable": true
          }
        },
        "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": {}
}
```