Jump to

• Request
• Response

Find a specific Group

get

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

Returns the details of all the Group based on the entryUUID provided

Request

Supported Media Types

• application/scim+json

Path Parameters

• entryUUID: string
  entryUUID for the Group to be fetched.

Back to Top

Response

Supported Media Types

• application/scim+json

200 Response

OK

Body ()

Root Schema : SuccessResponse

Type: object

Show Source

• Resources: array Resources
  Number of search result entries returned after the LDAP operation.
• schemas: string
  Default Value: urn:ietf:params:scim:api:messages:2.0:ListResponse

  The REST message schema
• totalResults: 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/SearchResultEntry"
            }
        }
    }
}

Nested Schema : Resources

Type: array

Number of search result entries returned after the LDAP operation.

Show Source

• Array of: object SearchResultEntry

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

Nested Schema : SearchResultEntry

Type: object

Show Source

• id(optional): string
  The id of the particular schema.
• meta(optional): object meta
  The meta values for the particular schema.
• schemas: string
  Allowed Values: [ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:User", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User" ]

  The Schemas to be included for the schema type.
• urn:ietf:params:scim:schemas:core:2.0:User(optional): object Core User Properties
• urn:ietf:params:scim:schemas:extension:enterprise:2.0:User(optional): object Enterprise specific User Properties
• urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:User(optional): object Oracle specific User 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:User",
                "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:User",
                "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
            ]
        },
        "urn:ietf:params:scim:schemas:core:2.0:User":{
            "$ref":"#/definitions/Core User Properties"
        },
        "urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:User":{
            "$ref":"#/definitions/Oracle specific User Properties"
        },
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{
            "$ref":"#/definitions/Enterprise specific User Properties"
        },
        "id":{
            "description":"The id of the particular schema.",
            "type":"string"
        },
        "meta":{
            "description":"The meta values for the particular schema.",
            "type":"object",
            "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 : Core User Properties

Type: object

Show Source

• addresses(optional): array addresses
  SCIM SubAttributes:
  

  • streetAddress
  • formatted
  • country
  • postalCode
  • locality
  • region

  Addresses of the particular User.
• displayName(optional): array displayName
  Display name of the User.
• emails(optional): array emails
  email of that specific User.
• name: array name
  SCIM SubAttributes:
  

  • formatted
  • givenName
  • familyName

  Name of the particular User.
• password(optional): array password
  password of that specific User.
• phoneNumbers(optional): array phoneNumbers
  phoneNumbers of the specific User
• photos(optional): array photos
  jpeg for the particular User.
• preferredLanguage(optional): array preferredLanguage
  Preffered Language of that specific User.
• title(optional): array title
  title of that specific User.
• userName: array userName
  CN (common name) of the entry
• userType(optional): array userType
  Type of that specific User.
• x509Certificates(optional): array x509Certificates
  The certificates for the particular User.

{
    "type":"object",
    "required":[
        "userName",
        "name"
    ],
    "properties":{
        "userName":{
            "type":"array",
            "description":"CN (common name) of the entry",
            "items":{
                "type":"string"
            }
        },
        "name":{
            "type":"array",
            "description":"<b>SCIM SubAttributes:</b><br/><ul><li>formatted</li><li>givenName</li><li>familyName</li></ul>Name of the particular User.",
            "items":{
                "$ref":"#/definitions/nameSubAttributes"
            }
        },
        "displayName":{
            "type":"array",
            "description":"Display name of the User.",
            "items":{
                "type":"string"
            }
        },
        "phoneNumbers":{
            "type":"array",
            "description":"phoneNumbers of the specific User",
            "items":{
                "type":"string"
            }
        },
        "x509Certificates":{
            "type":"array",
            "description":"The certificates for the particular User.",
            "items":{
                "type":"object"
            }
        },
        "photos":{
            "type":"array",
            "description":"jpeg for the particular User.",
            "items":{
                "type":"string"
            }
        },
        "title":{
            "type":"array",
            "description":"title of that specific User.",
            "items":{
                "type":"string"
            }
        },
        "userType":{
            "type":"array",
            "description":"Type of that specific User.",
            "items":{
                "type":"string"
            }
        },
        "preferredLanguage":{
            "type":"array",
            "description":"Preffered Language of that specific User.",
            "items":{
                "type":"string"
            }
        },
        "password":{
            "type":"array",
            "description":"password of that specific User.",
            "items":{
                "type":"string"
            }
        },
        "emails":{
            "type":"array",
            "description":"email of that specific User.",
            "items":{
                "type":"string"
            }
        },
        "addresses":{
            "type":"array",
            "description":"<b>SCIM SubAttributes:</b><br/><ul><li>streetAddress</li><li>formatted</li><li>country</li><li>postalCode</li><li>locality</li><li>region</li></ul>Addresses of the particular User.",
            "items":{
                "$ref":"#/definitions/addressSubAttributes"
            }
        }
    }
}

Nested Schema : Enterprise specific User Properties

Type: object

Show Source

• department(optional): array department
  Department the User is part of.
• employeeNumber(optional): array employeeNumber
  employeeNumber of the User.
• manager(optional): array manager
  SCIM SubAttributes:
  

  • managerId
  • displayName

  Manager of the particular User.
• organization(optional): array organization
  Organization the User is part of.

{
    "type":"object",
    "properties":{
        "manager":{
            "type":"array",
            "description":"<b>SCIM SubAttributes:</b><br/><ul><li>managerId</li><li>displayName</li></ul>Manager of the particular User.",
            "items":{
                "$ref":"#/definitions/managerSubAttributes"
            }
        },
        "department":{
            "type":"array",
            "description":"Department the User is part of.",
            "items":{
                "type":"string"
            }
        },
        "organization":{
            "type":"array",
            "description":"Organization the User is part of.",
            "items":{
                "type":"string"
            }
        },
        "employeeNumber":{
            "type":"array",
            "description":"employeeNumber of the User.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : Oracle specific User Properties

Type: object

Show Source

• businessCategory(optional): array businessCategory
  Business Category of the User.
• carLicense(optional): array carLicense
  carLicense of the User.
• description(optional): array description
  Description of the User.
• destinationIndicator(optional): array destinationIndicator
  Destination Indicator of the User.
• facsimileTelephoneNumber(optional): array facsimileTelephoneNumber
  facsimileTelephoneNumber of the User.
• homePhone(optional): array homePhone
  Home Phone number of the User.
• initials(optional): array initials
  initials of the User.
• internationaliSDNNumber(optional): array internationaliSDNNumber
  internationaliSDNNumber of the User.
• labeledURI(optional): array labeledURI
  Uniform Resource Identifier with optional label.
• mobile(optional): array mobile
  Mobile of the User.
• objectClass(optional): array objectClass
  Objectclass(es) which this entry belongs to.
• pager(optional): array pager
  pager of the User.
• physicalDeliveryOfficeName(optional): array physicalDeliveryOfficeName
  Physical Delivery Office Name of the User.
• postOfficeBox(optional): array postOfficeBox
  postOfficeBox of the User.
• preferredDeliveryMethod(optional): string
  Delivery method preferred by the User.
• roomNumber(optional): array roomNumber
  Room Number of the User.
• secretary(optional): array secretary
  secretary of the User.
• teletexTerminalIdentifier(optional): array teletexTerminalIdentifier
  teletexTerminalIdentifier value of the User.
• telexNumber(optional): array telexNumber
  telexNumber of the User.
• userPKCS12(optional): array userPKCS12
  PKCS #12 PFX PDU for exchange of personal identity information.
• userSMIMECertificate(optional): array userSMIMECertificate
  PKCS#7 SignedData used to support S/MIME.
• x500UniqueIdentifier(optional): array x500UniqueIdentifier
  x500UniqueIdentifier of the User.

{
    "type":"object",
    "properties":{
        "objectClass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "mobile":{
            "type":"array",
            "description":"Mobile of the User.",
            "items":{
                "type":"string"
            }
        },
        "roomNumber":{
            "type":"array",
            "description":"Room Number of the User.",
            "items":{
                "type":"string"
            }
        },
        "teletexTerminalIdentifier":{
            "type":"array",
            "description":"teletexTerminalIdentifier value of the User.",
            "items":{
                "type":"string"
            }
        },
        "description":{
            "type":"array",
            "description":"Description of the User.",
            "items":{
                "type":"string"
            }
        },
        "carLicense":{
            "type":"array",
            "description":"carLicense of the User.",
            "items":{
                "type":"string"
            }
        },
        "telexNumber":{
            "type":"array",
            "description":"telexNumber of the User.",
            "items":{
                "type":"string"
            }
        },
        "postOfficeBox":{
            "type":"array",
            "description":"postOfficeBox of the User.",
            "items":{
                "type":"string"
            }
        },
        "secretary":{
            "type":"array",
            "description":"secretary of the User.",
            "items":{
                "type":"string"
            }
        },
        "userSMIMECertificate":{
            "type":"array",
            "description":"PKCS#7 SignedData used to support S/MIME.",
            "items":{
                "type":"string"
            }
        },
        "pager":{
            "type":"array",
            "description":"pager of the User.",
            "items":{
                "type":"string"
            }
        },
        "x500UniqueIdentifier":{
            "type":"array",
            "description":"x500UniqueIdentifier of the User.",
            "items":{
                "type":"string"
            }
        },
        "labeledURI":{
            "type":"array",
            "description":"Uniform Resource Identifier with optional label.",
            "items":{
                "type":"string"
            }
        },
        "preferredDeliveryMethod":{
            "type":"string",
            "description":"Delivery method preferred by the User."
        },
        "userPKCS12":{
            "type":"array",
            "description":"PKCS #12 PFX PDU for exchange of personal identity information.",
            "items":{
                "type":"string"
            }
        },
        "businessCategory":{
            "type":"array",
            "description":"Business Category of the User.",
            "items":{
                "type":"string"
            }
        },
        "internationaliSDNNumber":{
            "type":"array",
            "description":"internationaliSDNNumber of the User.",
            "items":{
                "type":"string"
            }
        },
        "destinationIndicator":{
            "type":"array",
            "description":"Destination Indicator of the User.",
            "items":{
                "type":"string"
            }
        },
        "facsimileTelephoneNumber":{
            "type":"array",
            "description":"facsimileTelephoneNumber of the User.",
            "items":{
                "type":"string"
            }
        },
        "homePhone":{
            "type":"array",
            "description":"Home Phone number of the User.",
            "items":{
                "type":"string"
            }
        },
        "initials":{
            "type":"array",
            "description":"initials of the User.",
            "items":{
                "type":"string"
            }
        },
        "physicalDeliveryOfficeName":{
            "type":"array",
            "description":"Physical Delivery Office Name of the User.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : addresses

Type: array

SCIM SubAttributes:

• streetAddress
• formatted
• country
• postalCode
• locality
• region

Addresses of the particular User.

Show Source

• Array of: object addressSubAttributes

{
    "type":"array",
    "description":"<b>SCIM SubAttributes:</b><br/><ul><li>streetAddress</li><li>formatted</li><li>country</li><li>postalCode</li><li>locality</li><li>region</li></ul>Addresses of the particular User.",
    "items":{
        "$ref":"#/definitions/addressSubAttributes"
    }
}

Nested Schema : displayName

Type: array

Display name of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Display name of the User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : emails

Type: array

email of that specific User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"email of that specific User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : name

Type: array

SCIM SubAttributes:

• formatted
• givenName
• familyName

Name of the particular User.

Show Source

• Array of: object nameSubAttributes

{
    "type":"array",
    "description":"<b>SCIM SubAttributes:</b><br/><ul><li>formatted</li><li>givenName</li><li>familyName</li></ul>Name of the particular User.",
    "items":{
        "$ref":"#/definitions/nameSubAttributes"
    }
}

Nested Schema : password

Type: array

password of that specific User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"password of that specific User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : phoneNumbers

Type: array

phoneNumbers of the specific User

Show Source

• Array of: string

{
    "type":"array",
    "description":"phoneNumbers of the specific User",
    "items":{
        "type":"string"
    }
}

Nested Schema : photos

Type: array

jpeg for the particular User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"jpeg for the particular User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : preferredLanguage

Type: array

Preffered Language of that specific User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Preffered Language of that specific User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : title

Type: array

title of that specific User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"title of that specific User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : userName

Type: array

CN (common name) of the entry

Show Source

• Array of: string

{
    "type":"array",
    "description":"CN (common name) of the entry",
    "items":{
        "type":"string"
    }
}

Nested Schema : userType

Type: array

Type of that specific User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Type of that specific User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : x509Certificates

Type: array

The certificates for the particular User.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The certificates for the particular User.",
    "items":{
        "type":"object"
    }
}

Nested Schema : addressSubAttributes

Type: object

Show Source

• country(optional): string
• formatted(optional): string
• locality(optional): string
• postalCode(optional): string
• region(optional): string
• streetAddress(optional): string

{
    "type":"object",
    "properties":{
        "formatted":{
            "type":"string"
        },
        "streetAddress":{
            "type":"string"
        },
        "region":{
            "type":"string"
        },
        "locality":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "postalCode":{
            "type":"string"
        }
    }
}

Nested Schema : nameSubAttributes

Type: object

Show Source

• familyName(optional): string
• formatted(optional): string
• givenName(optional): string

{
    "type":"object",
    "properties":{
        "formatted":{
            "type":"string"
        },
        "familyName":{
            "type":"string"
        },
        "givenName":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Nested Schema : department

Type: array

Department the User is part of.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Department the User is part of.",
    "items":{
        "type":"string"
    }
}

Nested Schema : employeeNumber

Type: array

employeeNumber of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"employeeNumber of the User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : manager

Type: array

SCIM SubAttributes:

• managerId
• displayName

Manager of the particular User.

Show Source

• Array of: object managerSubAttributes

{
    "type":"array",
    "description":"<b>SCIM SubAttributes:</b><br/><ul><li>managerId</li><li>displayName</li></ul>Manager of the particular User.",
    "items":{
        "$ref":"#/definitions/managerSubAttributes"
    }
}

Nested Schema : organization

Type: array

Organization the User is part of.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Organization the User is part of.",
    "items":{
        "type":"string"
    }
}

Nested Schema : managerSubAttributes

Type: object

Show Source

• displayName(optional): string
• managerId(optional): string

{
    "type":"object",
    "properties":{
        "managerId":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        }
    }
}

Nested Schema : businessCategory

Type: array

Business Category of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Business Category of the User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : carLicense

Type: array

carLicense of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"carLicense of the User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : description

Type: array

Description of the User.

Show Source

• Array of: string

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

Nested Schema : destinationIndicator

Type: array

Destination Indicator of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Destination Indicator of the User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : facsimileTelephoneNumber

Type: array

facsimileTelephoneNumber of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"facsimileTelephoneNumber of the User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : homePhone

Type: array

Home Phone number of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Home Phone number of the User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : initials

Type: array

initials of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"initials of the User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : internationaliSDNNumber

Type: array

internationaliSDNNumber of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"internationaliSDNNumber of the User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : labeledURI

Type: array

Uniform Resource Identifier with optional label.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Uniform Resource Identifier with optional label.",
    "items":{
        "type":"string"
    }
}

Nested Schema : mobile

Type: array

Mobile of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Mobile of the User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : objectClass

Type: array

Objectclass(es) which this entry belongs to.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

Nested Schema : pager

Type: array

pager of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"pager of the User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : physicalDeliveryOfficeName

Type: array

Physical Delivery Office Name of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Physical Delivery Office Name of the User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : postOfficeBox

Type: array

postOfficeBox of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"postOfficeBox of the User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : roomNumber

Type: array

Room Number of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Room Number of the User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : secretary

Type: array

secretary of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"secretary of the User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : teletexTerminalIdentifier

Type: array

teletexTerminalIdentifier value of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"teletexTerminalIdentifier value of the User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : telexNumber

Type: array

telexNumber of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"telexNumber of the User.",
    "items":{
        "type":"string"
    }
}

Nested Schema : userPKCS12

Type: array

PKCS #12 PFX PDU for exchange of personal identity information.

Show Source

• Array of: string

{
    "type":"array",
    "description":"PKCS #12 PFX PDU for exchange of personal identity information.",
    "items":{
        "type":"string"
    }
}

Nested Schema : userSMIMECertificate

Type: array

PKCS#7 SignedData used to support S/MIME.

Show Source

• Array of: string

{
    "type":"array",
    "description":"PKCS#7 SignedData used to support S/MIME.",
    "items":{
        "type":"string"
    }
}

Nested Schema : x500UniqueIdentifier

Type: array

x500UniqueIdentifier of the User.

Show Source

• Array of: string

{
    "type":"array",
    "description":"x500UniqueIdentifier of the User.",
    "items":{
        "type":"string"
    }
}

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