Jump to

• Request
• Response

Find all the Schemas

get

/iam/directory/oud/scim/v1/Schemas

Returns the details of schemas 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 : SchemaSuccessResponse

Type: object

Show Source

• Resources: array Resources
  Details of the schemas 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 search 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 search result entries returned."
        },
        "Resources":{
            "type":"array",
            "description":"Details of the schemas that have been created.",
            "items":{
                "$ref":"#/definitions/SchemaSearchResultEntry"
            }
        }
    }
}

Nested Schema : Resources

Type: array

Details of the schemas that have been created.

Show Source

• Array of: object SchemaSearchResultEntry

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

Nested Schema : SchemaSearchResultEntry

Type: object

Show Source

• attributes: array attributes
  The attributes for the particular schema.
• description: string
  The description of the particular schema.
• id: string
  The id of the particular schema.
• meta: object meta
  The meta values for the particular schema.
• name: string
  The name of the particular schema.
• schemas: array schemas
  The Schemas to be included for the schema type.

{
    "type":"object",
    "required":[
        "schemas",
        "id",
        "attributes",
        "name",
        "meta",
        "description"
    ],
    "properties":{
        "schemas":{
            "description":"The Schemas to be included for the schema type.",
            "type":"array",
            "items":{
                "type":"string"
            },
            "default":[
                "urn:ietf:params:scim:schemas:core:2.0:Schema"
            ]
        },
        "id":{
            "description":"The id of the particular schema.",
            "type":"string"
        },
        "attributes":{
            "description":"The attributes for the particular schema.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "name":{
            "description":"The name of the particular schema.",
            "type":"string"
        },
        "meta":{
            "description":"The meta values for the particular schema.",
            "type":"object",
            "items":{
                "type":"string"
            }
        },
        "description":{
            "description":"The description of the particular schema.",
            "type":"string"
        }
    }
}

Nested Schema : attributes

Type: array

The attributes for the particular schema.

Show Source

• Array of: string

{
    "description":"The attributes for the particular schema.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : meta

Type: object

The meta values for the particular schema.

Show Source

• Array of: string

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

Nested Schema : schemas

Type: array

The Schemas to be included for the schema type.

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

Show Source

• Array of: string

{
    "description":"The Schemas to be included for the schema type.",
    "type":"array",
    "items":{
        "type":"string"
    },
    "default":[
        "urn:ietf:params:scim:schemas:core:2.0:Schema"
    ]
}

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