List resource types

Get SCIM resource types

GET /api/v1/scim/v2/ResourceTypes

Error

A valid request URL is required to generate request examples

200

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 3,
  "itemsPerPage": 3,
  "startIndex": 1,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id": "User",
      "name": "User",
      "description": "User Account",
      "endpoint": "/Users",
      "schema": "urn:ietf:params:scim:schemas:core:2.0:User",
      "schemaExtensions": [
        {
          "schema": "urn:lightdash:params:scim:schemas:extension:2.0:User",
          "required": false
        }
      ],
      "meta": {
        "resourceType": "ResourceType",
        "location": "https://<tenant>.lightdash.cloud/api/v1/scim/v2/ResourceTypes/User"
      }
    },
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id": "Group",
      "name": "Group",
      "description": "Group",
      "endpoint": "/Groups",
      "schema": "urn:ietf:params:scim:schemas:core:2.0:Group",
      "meta": {
        "resourceType": "ResourceType",
        "location": "https://<tenant>.lightdash.cloud/api/v1/scim/v2/ResourceTypes/Group"
      }
    },
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "id": "Role",
      "name": "Role",
      "description": "Role",
      "endpoint": "/Roles",
      "schema": "urn:ietf:params:scim:schemas:extension:2.0:Role",
      "meta": {
        "resourceType": "ResourceType",
        "location": "https://<tenant>.lightdash.cloud/api/v1/scim/v2/ResourceTypes/Role"
      }
    }
  ]
}

Response

200 - application/json

Ok

schemas · enum<string>[] · required

Available options: urn:ietf:params:scim:api:messages:2.0:ListResponse

totalResults · number<double> · required

itemsPerPage · number<double> · required

startIndex · number<double> · required

Resources · object[] · required

Show child attributes