Jump to

• Request
• Response

Find all the Resources

get

/iam/directory/oud/scim/v1/ResourceTypes

Returns the details of Resources created and supported

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/scim+json

200 Response

OK

Body ()

Root Schema : ResourceTypesSuccessResponse

Type: object

Show Source

• Resources: array Resources
  Details of all the ResourceTypes that have been created.
• schemas: string
  Default Value: urn:ietf:params:scim:api:messages:2.0:ListResponse

  The REST message schema
• totalResults: integer(int32)
  Number of result entries returned.

{
    "type":"object",
    "required":[
        "schemas",
        "totalResults",
        "Resources"
    ],
    "properties":{
        "schemas":{
            "description":"The REST message schema",
            "type":"string",
            "default":"urn:ietf:params:scim:api:messages:2.0:ListResponse"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Number of result entries returned."
        },
        "Resources":{
            "type":"array",
            "description":"Details of all the ResourceTypes that have been created.",
            "items":{
                "$ref":"#/definitions/ResourceTypesSearchResultEntry"
            }
        }
    }
}

Nested Schema : Resources

Type: array

Details of all the ResourceTypes that have been created.

Show Source

• Array of: object ResourceTypesSearchResultEntry

{
    "type":"array",
    "description":"Details of all the ResourceTypes that have been created.",
    "items":{
        "$ref":"#/definitions/ResourceTypesSearchResultEntry"
    }
}

Nested Schema : ResourceTypesSearchResultEntry

Type: object

Show Source

• description: string
  The description of the particular Resource.
• endpoint: string
  The endpoint of the particular Resource.
• meta: object meta
  The meta values for the particular Resource.
• name: string
  The name of the particular Resource.
• schemaExtensions(optional): array schemaExtensions
  The schema extentions for the particular Resource.
• schemas: array schemas
  The Schemas to b/Userse included for the ResourceType.

{
    "type":"object",
    "required":[
        "schemas",
        "endpoint",
        "name",
        "meta",
        "description"
    ],
    "properties":{
        "schemas":{
            "description":"The Schemas to b/Userse included for the ResourceType.",
            "type":"array",
            "items":{
                "type":"string"
            },
            "default":[
                "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
            ]
        },
        "endpoint":{
            "description":"The endpoint of the particular Resource.",
            "type":"string"
        },
        "schemaExtensions":{
            "description":"The schema extentions for the particular Resource.",
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "name":{
            "description":"The name of the particular Resource.",
            "type":"string"
        },
        "meta":{
            "description":"The meta values for the particular Resource.",
            "type":"object",
            "items":{
                "type":"string"
            }
        },
        "description":{
            "description":"The description of the particular Resource.",
            "type":"string"
        }
    }
}

Nested Schema : meta

Type: object

The meta values for the particular Resource.

Show Source

• Array of: string

{
    "description":"The meta values for the particular Resource.",
    "type":"object",
    "items":{
        "type":"string"
    }
}

Nested Schema : schemaExtensions

Type: array

The schema extentions for the particular Resource.

Show Source

• Array of: object items

{
    "description":"The schema extentions for the particular Resource.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : schemas

Type: array

The Schemas to b/Userse included for the ResourceType.

Default Value: [ "urn:ietf:params:scim:schemas:core:2.0:ResourceType" ]

Show Source

• Array of: string

{
    "description":"The Schemas to b/Userse included for the ResourceType.",
    "type":"array",
    "items":{
        "type":"string"
    },
    "default":[
        "urn:ietf:params:scim:schemas:core:2.0:ResourceType"
    ]
}

Nested Schema : items

Type: object

406 Response

Not Acceptable

Body ()

Root Schema : ErrorResponse

Type: object

Show Source

• detail: string
  Error message returned returned for the operation.
• schemas: string
  Default Value: urn:ietf:params:scim:api:messages:2.0:Error

  The REST message type
• status: integer(int32)
  Specifies the HTTP status error code returned for the operation.

{
    "type":"object",
    "required":[
        "schemas",
        "detail",
        "status"
    ],
    "properties":{
        "schemas":{
            "description":"The REST message type",
            "default":"urn:ietf:params:scim:api:messages:2.0:Error",
            "type":"string"
        },
        "detail":{
            "description":"Error message returned returned for the operation.",
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the HTTP status error code returned for the operation."
        }
    }
}

Back to Top