SCIM REST API for Oracle Unified Directory

Replace a group

put

/iam/directory/oud/scim/v1/Groups/{entryUUID}

Used to replace a Group in the directory. The body contains the group with the details it needs to be replaced with and the response has the details after it has been modified.

Request

Supported Media Types

application/scim+json

Path Parameters

entryUUID(required): string

entryUUID for the LDAP entry to be fetched.

User that needs to be created

Root Schema : POSTANDPUTRequestForGROUP

Type: object

Show Source

schemas(required): array schemas

The Schemas to be included for the schema type.
urn:ietf:params:scim:schemas:core:2.0:Group(required): object Core Group Properties
urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:Group: object Oracle specific Group Properties

{
    "type":"object",
    "required":[
        "schemas",
        "urn:ietf:params:scim:schemas:core:2.0:Group"
    ],
    "properties":{
        "schemas":{
            "description":"The Schemas to be included for the schema type.",
            "type":"array",
            "items":{
                "type":"object",
                "enum":[
                    "urn:ietf:params:scim:schemas:core:2.0:Group",
                    "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:Group"
                ]
            }
        },
        "urn:ietf:params:scim:schemas:core:2.0:Group":{
            "$ref":"#/definitions/Core Group Properties"
        },
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:Group":{
            "$ref":"#/definitions/Oracle specific Group Properties"
        }
    }
}

Nested Schema : schemas

Type: array

The Schemas to be included for the schema type.

Show Source

Array of: object items

{
    "description":"The Schemas to be included for the schema type.",
    "type":"array",
    "items":{
        "type":"object",
        "enum":[
            "urn:ietf:params:scim:schemas:core:2.0:Group",
            "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:Group"
        ]
    }
}

Nested Schema : Core Group Properties

Type: object

Show Source

displayName(required): string

Display name for the group.
members(required): array members

Members belonging to the Group.

{
    "type":"object",
    "required":[
        "members",
        "displayName"
    ],
    "properties":{
        "members":{
            "type":"array",
            "description":"Members belonging to the Group.",
            "items":{
                "type":"string"
            }
        },
        "displayName":{
            "type":"string",
            "description":"Display name for the group."
        }
    }
}

Nested Schema : Oracle specific Group Properties

Type: object

Show Source

businessCategory: array businessCategory

Buisness Category of the Group.
description: array description

Description of the Group.
o: array o

Organiation the group is a part of.
objectClass: array objectClass

Objectclass(es) required for the Group.
ou: array ou

Organizational Unit the Group is a part of.
owner: array owner

Owner of the group.

{
    "type":"object",
    "properties":{
        "objectClass":{
            "type":"array",
            "description":"Objectclass(es) required for the Group.",
            "items":{
                "type":"string"
            }
        },
        "description":{
            "type":"array",
            "description":"Description of the Group.",
            "items":{
                "type":"string"
            }
        },
        "owner":{
            "type":"array",
            "description":"Owner of the group.",
            "items":{
                "type":"string"
            }
        },
        "ou":{
            "type":"array",
            "description":"Organizational Unit the Group is a part of.",
            "items":{
                "type":"string"
            }
        },
        "businessCategory":{
            "type":"array",
            "description":"Buisness Category of the Group.",
            "items":{
                "type":"string"
            }
        },
        "o":{
            "type":"array",
            "description":"Organiation the group is a part of.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Allowed Values:

[
    "urn:ietf:params:scim:schemas:core:2.0:Group",
    "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:Group"
]

Nested Schema : members

Type: array

Members belonging to the Group.

Show Source

Array of: string

{
    "type":"array",
    "description":"Members belonging to the Group.",
    "items":{
        "type":"string"
    }
}

Nested Schema : businessCategory

Type: array

Buisness Category of the Group.

Show Source

Array of: string

{
    "type":"array",
    "description":"Buisness Category of the Group.",
    "items":{
        "type":"string"
    }
}

Nested Schema : description

Type: array

Description of the Group.

Show Source

Array of: string

{
    "type":"array",
    "description":"Description of the Group.",
    "items":{
        "type":"string"
    }
}

Nested Schema : o

Type: array

Organiation the group is a part of.

Show Source

Array of: string

{
    "type":"array",
    "description":"Organiation the group is a part of.",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectClass

Type: array

Objectclass(es) required for the Group.

Show Source

Array of: string

{
    "type":"array",
    "description":"Objectclass(es) required for the Group.",
    "items":{
        "type":"string"
    }
}

Nested Schema : ou

Type: array

Organizational Unit the Group is a part of.

Show Source

Array of: string

{
    "type":"array",
    "description":"Organizational Unit the Group is a part of.",
    "items":{
        "type":"string"
    }
}

Nested Schema : owner

Type: array

Owner of the group.

Show Source

Array of: string

{
    "type":"array",
    "description":"Owner of the group.",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/scim+json

200 Response

Root Schema : GroupSuccessResponse

Type: object

Show Source

Resources(required): array Resources

Number of search result entries returned after the LDAP operation.
schemas(required): string

Default Value: urn:ietf:params:scim:api:messages:2.0:ListResponse

The REST message schema
totalResults(required): integer(int32)

Specifies the number of entries created, and 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":"Specifies the number of entries created, and returned."
        },
        "Resources":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/GroupSearchResultEntry"
            }
        }
    }
}

Nested Schema : Resources

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

Array of: object GroupSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/GroupSearchResultEntry"
    }
}

Nested Schema : GroupSearchResultEntry

Type: object

Show Source

schemas(required): string

Allowed Values: [ "urn:ietf:params:scim:schemas:core:2.0:Group", "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:Group" ]

The Schemas to be included for the schema type.
urn:ietf:params:scim:schemas:core:2.0:Group: object Core Group Properties
urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:Group: object Oracle specific Group Properties

{
    "type":"object",
    "required":[
        "schemas"
    ],
    "properties":{
        "schemas":{
            "description":"The Schemas to be included for the schema type.",
            "type":"string",
            "enum":[
                "urn:ietf:params:scim:schemas:core:2.0:Group",
                "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:Group"
            ]
        },
        "urn:ietf:params:scim:schemas:core:2.0:Group":{
            "$ref":"#/definitions/Core Group Properties"
        },
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:Group":{
            "$ref":"#/definitions/Oracle specific Group Properties"
        }
    }
}

Nested Schema : Core Group Properties

Type: object

Show Source

displayName(required): string

Display name for the group.
members(required): array members

Members belonging to the Group.

{
    "type":"object",
    "required":[
        "members",
        "displayName"
    ],
    "properties":{
        "members":{
            "type":"array",
            "description":"Members belonging to the Group.",
            "items":{
                "type":"string"
            }
        },
        "displayName":{
            "type":"string",
            "description":"Display name for the group."
        }
    }
}

Nested Schema : Oracle specific Group Properties

Type: object

Show Source

businessCategory: array businessCategory

Buisness Category of the Group.
description: array description

Description of the Group.
o: array o

Organiation the group is a part of.
objectClass: array objectClass

Objectclass(es) required for the Group.
ou: array ou

Organizational Unit the Group is a part of.
owner: array owner

Owner of the group.

{
    "type":"object",
    "properties":{
        "objectClass":{
            "type":"array",
            "description":"Objectclass(es) required for the Group.",
            "items":{
                "type":"string"
            }
        },
        "description":{
            "type":"array",
            "description":"Description of the Group.",
            "items":{
                "type":"string"
            }
        },
        "owner":{
            "type":"array",
            "description":"Owner of the group.",
            "items":{
                "type":"string"
            }
        },
        "ou":{
            "type":"array",
            "description":"Organizational Unit the Group is a part of.",
            "items":{
                "type":"string"
            }
        },
        "businessCategory":{
            "type":"array",
            "description":"Buisness Category of the Group.",
            "items":{
                "type":"string"
            }
        },
        "o":{
            "type":"array",
            "description":"Organiation the group is a part of.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : members

Type: array

Members belonging to the Group.

Show Source

Array of: string

{
    "type":"array",
    "description":"Members belonging to the Group.",
    "items":{
        "type":"string"
    }
}

Nested Schema : businessCategory

Type: array

Buisness Category of the Group.

Show Source

Array of: string

{
    "type":"array",
    "description":"Buisness Category of the Group.",
    "items":{
        "type":"string"
    }
}

Nested Schema : description

Type: array

Description of the Group.

Show Source

Array of: string

{
    "type":"array",
    "description":"Description of the Group.",
    "items":{
        "type":"string"
    }
}

Nested Schema : o

Type: array

Organiation the group is a part of.

Show Source

Array of: string

{
    "type":"array",
    "description":"Organiation the group is a part of.",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectClass

Type: array

Objectclass(es) required for the Group.

Show Source

Array of: string

{
    "type":"array",
    "description":"Objectclass(es) required for the Group.",
    "items":{
        "type":"string"
    }
}

Nested Schema : ou

Type: array

Organizational Unit the Group is a part of.

Show Source

Array of: string

{
    "type":"array",
    "description":"Organizational Unit the Group is a part of.",
    "items":{
        "type":"string"
    }
}

Nested Schema : owner

Type: array

Owner of the group.

Show Source

Array of: string

{
    "type":"array",
    "description":"Owner of the group.",
    "items":{
        "type":"string"
    }
}

400 Response

Bad Request

Root Schema : ErrorResponse

Type: object

Show Source

detail(required): string

Error message returned returned for the operation.
schemas(required): string

Default Value: urn:ietf:params:scim:api:messages:2.0:Error

The REST message type
status(required): 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."
        }
    }
}

406 Response

Not Acceptable

Root Schema : ErrorResponse

Type: object

Show Source

detail(required): string

Error message returned returned for the operation.
schemas(required): string

Default Value: urn:ietf:params:scim:api:messages:2.0:Error

The REST message type
status(required): 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."
        }
    }
}