Oracle Unified Directory SCIM REST API

特定のユーザーの検索

get

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

特定のユーザー(entryUUIDに基づくユーザー)の詳細を返します

リクエスト

サポートされているメディア・タイプ

application/scim+json

パス・パラメータ

entryUUID(required): string

フェッチするLDAPエントリのentryUUID。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

application/scim+json

200レスポンス

ルート・スキーマ: SuccessResponse

型: object

ソースを表示

Resources(required): array Resources

LDAP操作後に返される検索結果エントリの数。
schemas(required): string

デフォルト値: urn:ietf:params:scim:api:messages:2.0:ListResponse

RESTメッセージ・スキーマ
totalResults(required): integer(int32)

作成され、返されるエントリの数を指定します。

{
    "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"
            }
        }
    }
}

ネストされたスキーマ: Resources

型: array

LDAP操作後に返される検索結果エントリの数。

ソースを表示

配列: オブジェクト SearchResultEntry

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

ネストされたスキーマ: SearchResultEntry

型: object

ソースを表示

id: string

特定のスキーマのID。
meta: object meta

特定のスキーマのメタ値。
schemas(required): string

指定可能な値: [ "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: object Core User Properties
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User: object Enterprise specific User Properties
urn:ietf:params:scim:schemas:extension:oracle:2.0:OUD:User: 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"
            }
        }
    }
}

ネストされたスキーマ: meta

型: object

特定のスキーマのメタ値。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: Core User Properties

型: object

ソースを表示

addresses: array addresses
SCIM SubAttributes:
- streetAddress
- formatted
- country
- postalCode
- locality
- region
特定のユーザーのアドレス。
displayName: array displayName

ユーザーの表示名。
emails: array emails

その特定のユーザーの電子メール。
name(required): array name
SCIM SubAttributes:
- formatted
- givenName
- familyName
特定のユーザーの名前。
password: array password

その特定のユーザーのパスワード。
phoneNumbers: array phoneNumbers

特定のユーザーのphoneNumbers
photos: array photos

特定のユーザーのjpeg。
preferredLanguage: array preferredLanguage

その特定のユーザーの優先言語。
title: array title

その特定のユーザーの役職。
userName(required): array userName

エントリのCN (共通名)
userType: array userType

その特定のユーザーのタイプ。
x509Certificates: array x509Certificates

特定のユーザーの証明書。

{
    "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"
            }
        }
    }
}

ネストされたスキーマ: Enterprise specific User Properties

型: object

ソースを表示

department: array department

ユーザーが属する部門。
employeeNumber: array employeeNumber

ユーザーのemployeeNumber。
manager: array manager
SCIM SubAttributes:
- managerId
- displayName
特定のユーザーのマネージャ。
organization: array organization

ユーザーが属する組織。

{
    "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"
            }
        }
    }
}

ネストされたスキーマ: Oracle specific User Properties

型: object

ソースを表示

businessCategory: array businessCategory

ユーザーのビジネス・カテゴリ。
carLicense: array carLicense

ユーザーのcarLicense。
description: array description

ユーザーの説明。
destinationIndicator: array destinationIndicator

ユーザーの宛先インジケータ。
facsimileTelephoneNumber: array facsimileTelephoneNumber

ユーザーのfacsimileTelephoneNumber。
homePhone: array homePhone

ユーザーの自宅電話番号。
initials: array initials

ユーザーのイニシャル。
internationaliSDNNumber: array internationaliSDNNumber

ユーザーのinternationaliSDNNumber。
labeledURI: array labeledURI

オプションのラベルを含むUniform Resource Identifier。
mobile: array mobile

ユーザーのモバイル。
objectClass: array objectClass

このエントリが属するオブジェクト・クラス。
pager: array pager

ユーザーのポケットベル。
physicalDeliveryOfficeName: array physicalDeliveryOfficeName

ユーザーのオフィス名。
postOfficeBox: array postOfficeBox

ユーザーのpostOfficeBox。
preferredDeliveryMethod: string

ユーザーが優先する実施メソッド。
roomNumber: array roomNumber

ユーザーの部屋番号。
secretary: array secretary

ユーザーの秘書。
teletexTerminalIdentifier: array teletexTerminalIdentifier

ユーザーのteletexTerminalIdentifier値。
telexNumber: array telexNumber

ユーザーのtelexNumber。
userPKCS12: array userPKCS12

個人識別情報の交換用のPKCS #12 PFX PDU。
userSMIMECertificate: array userSMIMECertificate

S/MIMEのサポートに使用されるPKCS # 7 SignedData。
x500UniqueIdentifier: array x500UniqueIdentifier

ユーザーのx500UniqueIdentifier。

{
    "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"
            }
        }
    }
}

ネストされたスキーマ: addresses

型: array

SCIM SubAttributes:

streetAddress
formatted
country
postalCode
locality
region

特定のユーザーのアドレス。

ソースを表示

配列: オブジェクト 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"
    }
}

ネストされたスキーマ: displayName

型: array

ユーザーの表示名。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: emails

型: array

その特定のユーザーの電子メール。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: name

型: array

SCIM SubAttributes:

formatted
givenName
familyName

特定のユーザーの名前。

ソースを表示

配列: オブジェクト 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"
    }
}

ネストされたスキーマ: password

型: array

その特定のユーザーのパスワード。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: phoneNumbers

型: array

特定のユーザーのphoneNumbers

ソースを表示

配列: 文字列

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

ネストされたスキーマ: photos

型: array

特定のユーザーのjpeg。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: preferredLanguage

型: array

その特定のユーザーの優先言語。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: title

型: array

その特定のユーザーの役職。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: userName

型: array

エントリのCN (共通名)

ソースを表示

配列: 文字列

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

ネストされたスキーマ: userType

型: array

その特定のユーザーのタイプ。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: x509Certificates

型: array

特定のユーザーの証明書。

ソースを表示

配列: オブジェクト items

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

ネストされたスキーマ: addressSubAttributes

型: object

ソースを表示

country: string
formatted: string
locality: string
postalCode: string
region: string
streetAddress: string

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

ネストされたスキーマ: nameSubAttributes

型: object

ソースを表示

familyName: string
formatted: string
givenName: string

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

ネストされたスキーマ: items

型: object

ネストされたスキーマ: department

型: array

ユーザーが属する部門。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: employeeNumber

型: array

ユーザーのemployeeNumber。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: manager

型: array

SCIM SubAttributes:

managerId
displayName

特定のユーザーのマネージャ。

ソースを表示

配列: オブジェクト 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"
    }
}

ネストされたスキーマ: organization

型: array

ユーザーが属する組織。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: managerSubAttributes

型: object

ソースを表示

displayName: string
managerId: string

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

ネストされたスキーマ: businessCategory

型: array

ユーザーのビジネス・カテゴリ。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: carLicense

型: array

ユーザーのcarLicense。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: description

型: array

ユーザーの説明。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: destinationIndicator

型: array

ユーザーの宛先インジケータ。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: facsimileTelephoneNumber

型: array

ユーザーのfacsimileTelephoneNumber。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: homePhone

型: array

ユーザーの自宅電話番号。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: initials

型: array

ユーザーのイニシャル。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: internationaliSDNNumber

型: array

ユーザーのinternationaliSDNNumber。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: labeledURI

型: array

オプションのラベルを含むUniform Resource Identifier。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: mobile

型: array

ユーザーのモバイル。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: objectClass

型: array

このエントリが属するオブジェクト・クラス。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: pager

型: array

ユーザーのポケットベル。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: physicalDeliveryOfficeName

型: array

ユーザーのオフィス名。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: postOfficeBox

型: array

ユーザーのpostOfficeBox。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: roomNumber

型: array

ユーザーの部屋番号。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: secretary

型: array

ユーザーの秘書。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: teletexTerminalIdentifier

型: array

ユーザーのteletexTerminalIdentifier値。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: telexNumber

型: array

ユーザーのtelexNumber。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: userPKCS12

型: array

個人識別情報の交換用のPKCS #12 PFX PDU。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: userSMIMECertificate

型: array

S/MIMEのサポートに使用されるPKCS # 7 SignedData。

ソースを表示

配列: 文字列

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

ネストされたスキーマ: x500UniqueIdentifier

型: array

ユーザーのx500UniqueIdentifier。

ソースを表示

配列: 文字列

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

406レスポンス

Not Acceptable

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

detail(required): string

操作に対して返されるエラー・メッセージ。
schemas(required): string

デフォルト値: urn:ietf:params:scim:api:messages:2.0:Error

RESTメッセージ・タイプ
status(required): integer(int32)

操作に対して返されるHTTPステータス・エラー・コードを指定します。

{
    "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."
        }
    }
}

先頭に戻る