Saml Xaspワークフロー要素の追加、検索、比較または削除
POST
/rest/v1/admin
Saml Xaspワークフロー要素の追加、検索、比較または削除
リクエスト
サポートされているメディア・タイプ
- application/json
作成する必要があるSaml Xaspワークフロー要素
ルート・スキーマ: Saml Xaspワークフロー要素のPOSTRequest
型:
ソースを表示
object
- assertion(optional): string
LDAP比較操作用のアサーション文字列。注意: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
- attributes(optional): object Saml Xaspワークフロー要素のプロパティ
- base(optional): string
LDAP検索操作に使用する検索ベースDN。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。このような操作の場合も必須です
- controls(optional): array controls
LDAP操作のためにサーバーに送信するLDAP制御。
- dn(optional): 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(optional): string
LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。注意: POSTリクエストを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
- msgType: string
指定可能な値:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest", "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(optional): array requiredAttributes
エントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
- scope(optional): string
指定可能な値:
[ "base", "sub", "one" ]
LDAP検索操作の範囲。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ネストされたスキーマ: Saml Xaspワークフロー要素のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-enabled: boolean
サーバーでワークフロー要素が使用可能かどうかを示します。
- ds-cfg-java-class: string
デフォルト値:
org.opends.server.workflowelement.ovdplugin.xasp.SamlXaspWorkflowElement
Saml Xaspワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-xasp-attribute-name: string
検索フィルタ内のエントリのDNを含む属性を定義します(certificatednなど)。
- ds-cfg-xasp-base-dn: string
フィルタに値がない場合に使用されるベースDN。
- ds-cfg-xasp-contains-dn: string
エントリのDNに含まれる必要のある文字列を定義します(dc=exampleなど)。
- ds-cfg-xasp-debug(optional): boolean
デフォルト値:
false
追加のメッセージをログに記録するかどうかを指定します。 - ds-cfg-xasp-index(optional): string
結果の索引作成に使用される属性のカンマ区切りのリストを定義します(cnなど)。
- ds-cfg-xasp-response(optional): string
戻される各エントリに追加される属性=値のペアのカンマ区切りリストを定義します(department=Salesなど)。
- ds-cfg-xasp-reverse-dn(optional): boolean
デフォルト値:
false
証明書に含まれるDNを逆方向にするかどうかを定義します(dc=com,dc=example,cn=users,cn=user1など)。 - ds-cfg-xasp-ttl(optional): string
キャッシュの有効期限をミリ秒単位で定義します。
- ds-cfg-xasp-ws-url: string
アイデンティティ・プロバイダのWebサービスURLを定義します。
- objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
ネストされたスキーマ: requiredAttributes
型:
array
エントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
ソースを表示
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK
ルート・スキーマ: Saml Xaspワークフロー要素のSuccessResponse
型:
ソースを表示
object
- compareResult(optional): boolean
LDAP比較操作の結果を示します。
- msgType: string
指定可能な値:
[ "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse" ]
RESTメッセージ・タイプ - searchResultEntries: array searchResultEntries
LDAP操作後に返される検索結果エントリの数。
- totalResults: integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: Saml Xaspワークフロー要素のSearchResultEntry
型:
ソースを表示
object
- attributes: object Saml Xaspワークフロー要素のプロパティ
- dn: string
作成するエントリのLDAP DN。
ネストされたスキーマ: Saml Xaspワークフロー要素のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-enabled: boolean
サーバーでワークフロー要素が使用可能かどうかを示します。
- ds-cfg-java-class: string
デフォルト値:
org.opends.server.workflowelement.ovdplugin.xasp.SamlXaspWorkflowElement
Saml Xaspワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-xasp-attribute-name: string
検索フィルタ内のエントリのDNを含む属性を定義します(certificatednなど)。
- ds-cfg-xasp-base-dn: string
フィルタに値がない場合に使用されるベースDN。
- ds-cfg-xasp-contains-dn: string
エントリのDNに含まれる必要のある文字列を定義します(dc=exampleなど)。
- ds-cfg-xasp-debug(optional): boolean
デフォルト値:
false
追加のメッセージをログに記録するかどうかを指定します。 - ds-cfg-xasp-index(optional): string
結果の索引作成に使用される属性のカンマ区切りのリストを定義します(cnなど)。
- ds-cfg-xasp-response(optional): string
戻される各エントリに追加される属性=値のペアのカンマ区切りリストを定義します(department=Salesなど)。
- ds-cfg-xasp-reverse-dn(optional): boolean
デフォルト値:
false
証明書に含まれるDNを逆方向にするかどうかを定義します(dc=com,dc=example,cn=users,cn=user1など)。 - ds-cfg-xasp-ttl(optional): string
キャッシュの有効期限をミリ秒単位で定義します。
- ds-cfg-xasp-ws-url: string
アイデンティティ・プロバイダのWebサービスURLを定義します。
- objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
201レスポンス
作成済
ルート・スキーマ: Saml Xaspワークフロー要素のADDResponse
型:
ソースを表示
object
- msgType: string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse
RESTメッセージ・タイプ - searchResultEntries: array searchResultEntries
- totalResults: integer(int32)
作成され、返されるエントリの数を指定します。
ネストされたスキーマ: Saml Xaspワークフロー要素のSearchResultEntry
型:
ソースを表示
object
- attributes: object Saml Xaspワークフロー要素のプロパティ
- dn: string
作成するエントリのLDAP DN。
ネストされたスキーマ: Saml Xaspワークフロー要素のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-enabled: boolean
サーバーでワークフロー要素が使用可能かどうかを示します。
- ds-cfg-java-class: string
デフォルト値:
org.opends.server.workflowelement.ovdplugin.xasp.SamlXaspWorkflowElement
Saml Xaspワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。 - ds-cfg-xasp-attribute-name: string
検索フィルタ内のエントリのDNを含む属性を定義します(certificatednなど)。
- ds-cfg-xasp-base-dn: string
フィルタに値がない場合に使用されるベースDN。
- ds-cfg-xasp-contains-dn: string
エントリのDNに含まれる必要のある文字列を定義します(dc=exampleなど)。
- ds-cfg-xasp-debug(optional): boolean
デフォルト値:
false
追加のメッセージをログに記録するかどうかを指定します。 - ds-cfg-xasp-index(optional): string
結果の索引作成に使用される属性のカンマ区切りのリストを定義します(cnなど)。
- ds-cfg-xasp-response(optional): string
戻される各エントリに追加される属性=値のペアのカンマ区切りリストを定義します(department=Salesなど)。
- ds-cfg-xasp-reverse-dn(optional): boolean
デフォルト値:
false
証明書に含まれるDNを逆方向にするかどうかを定義します(dc=com,dc=example,cn=users,cn=user1など)。 - ds-cfg-xasp-ttl(optional): string
キャッシュの有効期限をミリ秒単位で定義します。
- ds-cfg-xasp-ws-url: string
アイデンティティ・プロバイダのWebサービスURLを定義します。
- objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
204レスポンス
コンテンツがありません
406レスポンス
受入れできません
ルート・スキーマ: ErrorResponse
型:
ソースを表示
object
- ldapErrorCode(optional): integer(int32)
操作に対して返されるLDAPエラー・コードを指定します。
- message: string
操作に対して返されるエラー・メッセージ。
- msgType: string
デフォルト値:
urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse
RESTメッセージ・タイプ