Resource Types

An HTTP GET to this endpoint is used to discover the types of resources available in INETAPP, e.g. Users and Groups. Each resource type defines the endpoints, the core schema URI that defines the resource, and any supported schema extensions.

GET /api/scim/v2/ResourceTypes

The response is a list of resource types. The attributes defining a resource type can be found in Section 6 of [RFC7643], and an example representation can be found in Section 8.6 of [RFC7643].

Example Request

# Request
GET /api/scim/v2/ResourceTypes HTTP/1.1
Authorization: Bearer VGhpcyBpcyBqdXN0IGEgZGVtbyBhY2Nlc3MgdG9rZW4u
 
# Response
HTTP/1.1 200 OK
Content-Type: application/scim+json
 
{
  "totalResults": 5,
  "Resources": [
    {
      "schema": "urn:ietf:params:scim:schemas:core:2.0:User",
      "endpoint": "/Users",
      "meta": {
        "location": "https://127.0.0.1:9000/api/scim/v2/ResourceTypes/Users",
        "resourceType": "User"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ],
      "name": "User",
      "description": "User Account",
      "schemaExtensions": [
        {
          "schema": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
          "required": true
        }
      ],
      "id": "User"
    },
    ...
  ],
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ]
}

Application Example

# Browser access
https://127.0.0.1:9000/api/scim/v2/ResourceTypes
 
# Shell access using curl
curl -LsH "Authorization: Bearer <access_token>" "https://127.0.0.1:9000/api/scim/v2/ResourceTypes"
 
# Shell access using curl using username and password
curl -Lsu username:password "https://127.0.0.1:9000/api/scim/v2/ResourceTypes"