OUDエントリの追加、削除、検索、変更または比較。
post
/rest/v1/directory
ディレクトリ内のエントリを追加、削除、検索、変更または比較します。
リクエスト
サポートされているメディア・タイプ
- application/json
作成する必要があるユーザー
ルート・スキーマ: POSTRequest
型:
ソースを表示
object
- assertion: string
LDAP比較操作用のアサーション文字列。ノート: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
- attributes: object Properties
- base: string
LDAP検索操作に使用する検索ベースDN。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。このような操作の場合も必須です
- controls: array controls
LDAP操作のためにサーバーに送信するLDAP制御。
- dn: string
作成、削除または比較するエントリのLDAP DN。ノート: LDAPの追加、削除または比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest、urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequestまたはurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。このような操作の場合に必須です。
- filter: string
LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。ノート: POSTリクエストを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
- msgType(required): string
指定可能な値:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest" ]
RESTメッセージ・タイプ - requiredAttributes: array requiredAttributes
エントリに対してフェッチする属性のリスト。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
- scope: string
指定可能な値:
[ "base", "sub", "one" ]
LDAP検索操作の範囲。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ネストされたスキーマ: Properties
型:
ソースを表示
object
- audio: array audio
対応するエントリのaudio
- businessCategory: array businessCategory
対応するエントリのbusinessCategory
- carLicense: array carLicense
対応するエントリのcarLicense
- cn(required): array cn
対応するエントリのcn
- departmentNumber: array departmentNumber
対応するエントリのdepartmentNumber
- description: array description
対応するエントリのdescription
- destinationIndicator: array destinationIndicator
対応するエントリのdestinationIndicator
- displayName: array displayName
対応するエントリのdisplayName
- employeeNumber: array employeeNumber
対応するエントリのemployeeNumber
- employeeType: array employeeType
対応するエントリのemployeeType
- facsimileTelephoneNumber: array facsimileTelephoneNumber
対応するエントリのfacsimileTelephoneNumber
- givenName: array givenName
対応するエントリのgivenName
- homePhone: array homePhone
対応するエントリのhomePhone
- homePostalAddress: array homePostalAddress
対応するエントリのhomePostalAddress
- initials: array initials
対応するエントリのinitials
- internationaliSDNNumber: array internationaliSDNNumber
対応するエントリのinternationaliSDNNumber
- jpegPhoto: array jpegPhoto
対応するエントリのjpegPhoto
- l: array l
対応するエントリのl
- labeledURI: array labeledURI
対応するエントリのlabeledURI
- mail: array mail
対応するエントリのmail
- manager: array manager
対応するエントリのmanager
- mobile: array mobile
対応するエントリのmobile
- o: array o
対応するエントリのo
- objectClass(required): array objectClass
対応するエントリのobjectClass
- ou: array ou
対応するエントリのou
- pager: array pager
対応するエントリのpager
- photo: array photo
対応するエントリのphoto
- physicalDeliveryOfficeName: array physicalDeliveryOfficeName
対応するエントリのphysicalDeliveryOfficeName
- postalAddress: array postalAddress
対応するエントリのpostalAddress
- postalCode: array postalCode
対応するエントリのpostalCode
- postOfficeBox: array postOfficeBox
対応するエントリのpostOfficeBox
- preferredDeliveryMethod: array preferredDeliveryMethod
対応するエントリのpreferredDeliveryMethod
- preferredLanguage: array preferredLanguage
対応するエントリのpreferredLanguage
- registeredAddress: array registeredAddress
対応するエントリのregisteredAddress
- roomNumber: array roomNumber
対応するエントリのroomNumber
- secretary: array secretary
対応するエントリのsecretary
- seeAlso: array seeAlso
対応するエントリのseeAlso
- sn: array sn
対応するエントリのsn
- st: array st
対応するエントリのst
- street: array street
対応するエントリのstreet
- telephoneNumber: array telephoneNumber
対応するエントリのtelephoneNumber
- teletexTerminalIdentifier: array teletexTerminalIdentifier
対応するエントリのteletexTerminalIdentifier
- telexNumber: array telexNumber
対応するエントリのtelexNumber
- title: array title
対応するエントリのtitle
- uid: array uid
対応するエントリのuid
- userCertificate: array userCertificate
対応するエントリのuserCertificate
- userPassword: array userPassword
対応するエントリのuserPassword
- userPKCS12: array userPKCS12
対応するエントリのuserPKCS12
- userSMIMECertificate: array userSMIMECertificate
対応するエントリのuserSMIMECertificate
- x121Address: array x121Address
対応するエントリのx121Address
- x500UniqueIdentifier: array x500UniqueIdentifier
対応するエントリのx500UniqueIdentifier
ネストされたスキーマ: requiredAttributes
型:
array
エントリに対してフェッチする属性のリスト。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ソースを表示
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK
ルート・スキーマ: SuccessResponse
型:
ソースを表示
object
- compareResult: boolean
LDAP比較操作の結果を示します。
- msgType(required): string
Allowed Values:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse" ]
RESTメッセージ・タイプ - searchResultEntries(required): array searchResultEntries
LDAP操作後に返される検索結果エントリの数。
- totalResults(required): integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: SearchResultEntry
型:
ソースを表示
object
- attributes(required): object プロパティ
- dn(required): string
作成、削除または比較するエントリのLDAP DN。ノート: LDAPの追加、削除または比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest、urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequestまたはurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。このような操作の場合に必須です。
ネストされたスキーマ: Properties
型:
ソースを表示
object
- audio: array audio
対応するエントリのaudio
- businessCategory: array businessCategory
対応するエントリのbusinessCategory
- carLicense: array carLicense
対応するエントリのcarLicense
- cn(required): array cn
対応するエントリのcn
- departmentNumber: array departmentNumber
対応するエントリのdepartmentNumber
- description: array description
対応するエントリのdescription
- destinationIndicator: array destinationIndicator
対応するエントリのdestinationIndicator
- displayName: array displayName
対応するエントリのdisplayName
- employeeNumber: array employeeNumber
対応するエントリのemployeeNumber
- employeeType: array employeeType
対応するエントリのemployeeType
- facsimileTelephoneNumber: array facsimileTelephoneNumber
対応するエントリのfacsimileTelephoneNumber
- givenName: array givenName
対応するエントリのgivenName
- homePhone: array homePhone
対応するエントリのhomePhone
- homePostalAddress: array homePostalAddress
対応するエントリのhomePostalAddress
- initials: array initials
対応するエントリのinitials
- internationaliSDNNumber: array internationaliSDNNumber
対応するエントリのinternationaliSDNNumber
- jpegPhoto: array jpegPhoto
対応するエントリのjpegPhoto
- l: array l
対応するエントリのl
- labeledURI: array labeledURI
対応するエントリのlabeledURI
- mail: array mail
対応するエントリのmail
- manager: array manager
対応するエントリのmanager
- mobile: array mobile
対応するエントリのmobile
- o: array o
対応するエントリのo
- objectClass(required): array objectClass
対応するエントリのobjectClass
- ou: array ou
対応するエントリのou
- pager: array pager
対応するエントリのpager
- photo: array photo
対応するエントリのphoto
- physicalDeliveryOfficeName: array physicalDeliveryOfficeName
対応するエントリのphysicalDeliveryOfficeName
- postalAddress: array postalAddress
対応するエントリのpostalAddress
- postalCode: array postalCode
対応するエントリのpostalCode
- postOfficeBox: array postOfficeBox
対応するエントリのpostOfficeBox
- preferredDeliveryMethod: array preferredDeliveryMethod
対応するエントリのpreferredDeliveryMethod
- preferredLanguage: array preferredLanguage
対応するエントリのpreferredLanguage
- registeredAddress: array registeredAddress
対応するエントリのregisteredAddress
- roomNumber: array roomNumber
対応するエントリのroomNumber
- secretary: array secretary
対応するエントリのsecretary
- seeAlso: array seeAlso
対応するエントリのseeAlso
- sn: array sn
対応するエントリのsn
- st: array st
対応するエントリのst
- street: array street
対応するエントリのstreet
- telephoneNumber: array telephoneNumber
対応するエントリのtelephoneNumber
- teletexTerminalIdentifier: array teletexTerminalIdentifier
対応するエントリのteletexTerminalIdentifier
- telexNumber: array telexNumber
対応するエントリのtelexNumber
- title: array title
対応するエントリのtitle
- uid: array uid
対応するエントリのuid
- userCertificate: array userCertificate
対応するエントリのuserCertificate
- userPassword: array userPassword
対応するエントリのuserPassword
- userPKCS12: array userPKCS12
対応するエントリのuserPKCS12
- userSMIMECertificate: array userSMIMECertificate
対応するエントリのuserSMIMECertificate
- x121Address: array x121Address
対応するエントリのx121Address
- x500UniqueIdentifier: array x500UniqueIdentifier
対応するエントリのx500UniqueIdentifier
201レスポンス
Created
ルート・スキーマ: ADDSuccessResponse
型:
ソースを表示
object
- msgType(required): string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse
RESTメッセージ・タイプ - searchResultEntries(required): array searchResultEntries
- totalResults(required): integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: SearchResultEntry
型:
ソースを表示
object
- attributes(required): object プロパティ
- dn(required): string
作成、削除または比較するエントリのLDAP DN。ノート: LDAPの追加、削除または比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest、urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequestまたはurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。このような操作の場合に必須です。
ネストされたスキーマ: Properties
型:
ソースを表示
object
- audio: array audio
対応するエントリのaudio
- businessCategory: array businessCategory
対応するエントリのbusinessCategory
- carLicense: array carLicense
対応するエントリのcarLicense
- cn(required): array cn
対応するエントリのcn
- departmentNumber: array departmentNumber
対応するエントリのdepartmentNumber
- description: array description
対応するエントリのdescription
- destinationIndicator: array destinationIndicator
対応するエントリのdestinationIndicator
- displayName: array displayName
対応するエントリのdisplayName
- employeeNumber: array employeeNumber
対応するエントリのemployeeNumber
- employeeType: array employeeType
対応するエントリのemployeeType
- facsimileTelephoneNumber: array facsimileTelephoneNumber
対応するエントリのfacsimileTelephoneNumber
- givenName: array givenName
対応するエントリのgivenName
- homePhone: array homePhone
対応するエントリのhomePhone
- homePostalAddress: array homePostalAddress
対応するエントリのhomePostalAddress
- initials: array initials
対応するエントリのinitials
- internationaliSDNNumber: array internationaliSDNNumber
対応するエントリのinternationaliSDNNumber
- jpegPhoto: array jpegPhoto
対応するエントリのjpegPhoto
- l: array l
対応するエントリのl
- labeledURI: array labeledURI
対応するエントリのlabeledURI
- mail: array mail
対応するエントリのmail
- manager: array manager
対応するエントリのmanager
- mobile: array mobile
対応するエントリのmobile
- o: array o
対応するエントリのo
- objectClass(required): array objectClass
対応するエントリのobjectClass
- ou: array ou
対応するエントリのou
- pager: array pager
対応するエントリのpager
- photo: array photo
対応するエントリのphoto
- physicalDeliveryOfficeName: array physicalDeliveryOfficeName
対応するエントリのphysicalDeliveryOfficeName
- postalAddress: array postalAddress
対応するエントリのpostalAddress
- postalCode: array postalCode
対応するエントリのpostalCode
- postOfficeBox: array postOfficeBox
対応するエントリのpostOfficeBox
- preferredDeliveryMethod: array preferredDeliveryMethod
対応するエントリのpreferredDeliveryMethod
- preferredLanguage: array preferredLanguage
対応するエントリのpreferredLanguage
- registeredAddress: array registeredAddress
対応するエントリのregisteredAddress
- roomNumber: array roomNumber
対応するエントリのroomNumber
- secretary: array secretary
対応するエントリのsecretary
- seeAlso: array seeAlso
対応するエントリのseeAlso
- sn: array sn
対応するエントリのsn
- st: array st
対応するエントリのst
- street: array street
対応するエントリのstreet
- telephoneNumber: array telephoneNumber
対応するエントリのtelephoneNumber
- teletexTerminalIdentifier: array teletexTerminalIdentifier
対応するエントリのteletexTerminalIdentifier
- telexNumber: array telexNumber
対応するエントリのtelexNumber
- title: array title
対応するエントリのtitle
- uid: array uid
対応するエントリのuid
- userCertificate: array userCertificate
対応するエントリのuserCertificate
- userPassword: array userPassword
対応するエントリのuserPassword
- userPKCS12: array userPKCS12
対応するエントリのuserPKCS12
- userSMIMECertificate: array userSMIMECertificate
対応するエントリのuserSMIMECertificate
- x121Address: array x121Address
対応するエントリのx121Address
- x500UniqueIdentifier: array x500UniqueIdentifier
対応するエントリのx500UniqueIdentifier
204レスポンス
No content
406レスポンス
Not Acceptable
ルート・スキーマ: ErrorResponse
型:
ソースを表示
object
- ldapErrorCode: integer(int32)
操作に対して返されるLDAPエラー・コードを指定します。
- message(required): string
操作に対して返されるエラー・メッセージ。
- msgType(required): string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse
RESTメッセージ・タイプ