Returns all ResourceType resources.

GET 
/ResourceTypes

All ResourceType resources are listed in the response. The common fields for each ResourceType entry are 'endpoint', 'id', 'name', 'description', 'schema' and 'schemaExtensions'.

Request

Responses

200

Returns all ResourceType resources.

application/json

Schema

Schema

totalResults integer

Number of ResourceType resources returned.

schemas string[]

The ResourceTypes type represented by URN used for this response.

Resources object[]
Array [
id string
ID of the ResourceType.
name string
Name of the ResourceType.
endpoint string
The ResourceType's HTTP addressable endpoint relative to the Base URL.
description string
Description of the ResourceType.
schema string
The primary/base schema URI of the ResourceType.
schemaExtensions undefined[]
A list of URIs of the ResourceType's schema extensions.
meta object
Metadata of the ResourceType.
location string
The location of the ResourceType.
resourceType string
The SCIM resource type.
schemas string[]
The schema for the ResourceType resource.
]

Example (from schema)

{
  "totalResults": 18,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "id": "User",
      "name": "User",
      "endpoint": "/Applications",
      "description": "User Account.",
      "schema": "urn:ietf:params:scim:schemas:sailpoint:1.0:User",
      "schemaExtensions": [
        [
          {
            "schema": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
            "required": true
          },
          {
            "schema": "urn:ietf:params:scim:schemas:sailpoint:1.0:User",
            "required": true
          }
        ]
      ],
      "meta": {
        "location": "http://localhost:8080/iiq/scim/v2/ResourceTypes/User",
        "resourceType": "ResourceType"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ]
    }
  ]
}

application/scim+json

Schema

Schema

totalResults integer

Number of Schema resources returned.

schemas string[]

The Schema type represented by URN used for this response.

Resources object[]
Array [
id string
ID of the ResourceType.
name string
Name of the ResourceType.
endpoint string
The ResourceType's HTTP addressable endpoint relative to the Base URL.
description string
Description of the ResourceType.
schema string
The primary/base schema URI of the ResourceType.
schemaExtensions undefined[]
A list of URIs of the ResourceType's schema extensions.
meta object
Metadata of the ResourceType.
location string
The location of the ResourceType.
resourceType string
The SCIM resource type.
schemas string[]
The schema for the ResourceType resource.
]

Example (from schema)

{
  "totalResults": 18,
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "id": "User",
      "name": "User",
      "endpoint": "/Applications",
      "description": "User Account.",
      "schema": "urn:ietf:params:scim:schemas:sailpoint:1.0:User",
      "schemaExtensions": [
        [
          {
            "schema": "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
            "required": true
          },
          {
            "schema": "urn:ietf:params:scim:schemas:sailpoint:1.0:User",
            "required": true
          }
        ]
      ],
      "meta": {
        "location": "http://localhost:8080/iiq/scim/v2/ResourceTypes/User",
        "resourceType": "ResourceType"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
      ]
    }
  ]
}

Loading...