ジャンプ先

• リクエスト
• レスポンス

DNによるプロキシLDAPワークフロー要素の変更

PATCH

/rest/v1/admin/{dn}

DNによるプロキシLDAPワークフロー要素の変更

リクエスト

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

• application/json

パス・パラメータ

• dn(required): string
  変更するエントリのLDAP DN。

本文 ()

変更する必要があるプロキシLDAPワークフロー要素

ルート・スキーマ: PatchRequest

型: object

ソースを表示

• controls: array controls
  LDAP変更操作のためにサーバーに送信するLDAP制御。
• msgType(required): string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest

  RESTメッセージ・タイプ
• operations(必須): array operations
  エントリに対して実行する変更(パッチ操作)。

{
    "type":"object",
    "required":[
        "msgType",
        "operations"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest",
            "type":"string"
        },
        "operations":{
            "type":"array",
            "description":"Modifications (Patch operations) to be performed on the entry.",
            "items":{
                "$ref":"#/definitions/PatchOperation"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for LDAP modify operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

LDAP変更操作のためにサーバーに送信するLDAP制御。

ソースを表示

• 配列: 文字列

{
    "description":"LDAP controls to be sent to server for LDAP modify operation.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

エントリに対して実行する変更(パッチ操作)。

ソースを表示

• 配列: オブジェクト PatchOperation

{
    "type":"array",
    "description":"Modifications (Patch operations) to be performed on the entry.",
    "items":{
        "$ref":"#/definitions/PatchOperation"
    }
}

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

型: object

ソースを表示

• attribute(required): string
  変更するエントリ属性。
• opType(required): string
  指定可能な値: [ "add", "delete", "replace", "increment" ]

  パッチ操作のタイプ。
• values: array values
  更新する属性値。

{
    "type":"object",
    "required":[
        "opType",
        "attribute"
    ],
    "properties":{
        "opType":{
            "description":"The type of the Patch Operation.",
            "type":"string",
            "enum":[
                "add",
                "delete",
                "replace",
                "increment"
            ]
        },
        "attribute":{
            "type":"string",
            "description":"The entry attribute to be modified."
        },
        "values":{
            "type":"array",
            "description":"The attribute values to be updated.",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

更新する属性値。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"The attribute values to be updated.",
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: プロキシLDAPワークフロー要素のPatchSuccessResponse

型: object

ソースを表示

• msgType(required): string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse

  RESTメッセージ・タイプ
• searchResultEntries(required): array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• totalResults(required): integer(int32)
  作成され、返されるエントリの数を指定します。

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/Proxy LDAP Workflow Element SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト プロキシLDAPワークフロー要素のSearchResultEntry

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

ネストされたスキーマ: プロキシLDAPワークフロー要素のSearchResultEntry

型: object

ソースを表示

• attributes(required): object プロキシLDAPワークフロー要素のプロパティ
• dn(required): string
  作成するエントリのLDAP DN。

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Proxy LDAP Workflow Element Properties"
        }
    }
}

ネストされたスキーマ: プロキシLDAPワークフロー要素のプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-client-cred-mode(required): string
  指定可能な値: [ "use-client-identity", "use-proxy-auth", "use-specific-identity" ]

  プロキシ・サーバーがリモートLDAPサーバーにバインドする方法を指定します。
• ds-cfg-enabled(required): boolean
  サーバーでワークフロー要素が使用可能かどうかを示します。
• ds-cfg-exclude-list: array ds-cfg-exclude-list
  このリストには一連のDNが含まれています。クライアント・バインドDNが除外リスト上のいずれかのDNの子である場合、包含リストの内容に関係なく、リモート・サーバーに対する認証はプロキシ資格証明を使用して実行されます。
• ds-cfg-include-list: array ds-cfg-include-list
  このリストには一連のDNが含まれています。クライアント・バインドDNがリスト上のいずれかのDNの子である場合、またはリストが空である場合、リモート・サーバーに対する認証を実行するためにクライアント資格証明を使用できます(クライアント・バインドDNが除外リスト上のいずれかのDNの子である場合を除きます)。never-bindフラグが無効になっている場合は、認証に対してサイレント・バインドが実行されます。never-bindフラグが有効になっている場合は、ユーザーのエントリがリモート・サーバーから取得され、資格証明がローカルでチェックされます。
• ds-cfg-java-class(required): string
  デフォルト値: com.sun.dps.server.workflowelement.proxyldap.ProxyLdapWorkflowElement

  プロキシLDAPワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-ldap-server-extension(required): string
  このプロキシLDAPワークフロー要素に対して構成されたLDAPサーバー拡張機能を識別します。
• ds-cfg-log-silent-bind-response-controls: boolean
  デフォルト値: false

  サイレント・バインドのレスポンス制御のロギングが有効であるかどうかを示します。
• ds-cfg-never-bind: boolean
  デフォルト値: false

  never-bindフラグが有効であるかどうかを示します。
• ds-cfg-never-bind-user-password-attribute: string
  デフォルト値: userPassword

  この属性は、リモート・サーバー上のユーザーの資格証明を識別する属性の説明を定義します。never-bindフラグが有効になっている場合にのみ関係します。この属性が省略されている場合、デフォルト値userPasswordがかわりに使用されます。
• ds-cfg-remote-ldap-server-bind-dn: string
  リモート・サーバーへの接続に使用されるDN。このDNはリモート・サーバー上に存在している必要があります。
• ds-cfg-remote-ldap-server-bind-password: string
  リモート・サーバーへの接続に使用されるパスワード。
• ds-cfg-remote-ldap-server-bind-password-file: string
  リモート・サーバーへの接続に使用されるパスワードを含むファイル。
• ds-cfg-remote-root-dn: string
  リモート・サーバーでの内部操作の実行に使用されるルートDN。このDNはリモート・サーバー上に存在している必要があります。値""は、匿名の資格証明を示します。""が指定された場合、remote-ldap-server-bind-passwordプロパティは無視されます。
• ds-cfg-remote-root-password: string
  リモート・サーバーに接続するためにルートDNで使用されるパスワード。
• ds-cfg-search-count-limit: integer(int32)
  デフォルト値: 0

  ldapsearchリクエストで使用されるデフォルトのサイズ制限値(クライアント・リクエストで指定されていない場合、またはクライアント・リクエストでサイズ制限値0が指定されている場合)。
• ds-cfg-use-proxy-auth: boolean
  デフォルト値: false

  このフラグは、LDAPコネクタがプロキシ認可制御を使用できるかどうかを示します。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-client-cred-mode",
        "ds-cfg-ldap-server-extension",
        "ds-cfg-enabled"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-java-class":{
            "description":"Specifies the fully-qualified name of the Java class that provides the Proxy LDAP Workflow Element implementation. ",
            "readOnly":false,
            "default":"com.sun.dps.server.workflowelement.proxyldap.ProxyLdapWorkflowElement",
            "type":"string"
        },
        "ds-cfg-remote-ldap-server-bind-dn":{
            "description":"DN which will be used to connect to a remote server. This DN must exist on the remote server. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-never-bind":{
            "description":"Indicates whether the never-bind flag is enabled. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-never-bind-user-password-attribute":{
            "description":"This attribute defines the description of the attribute that identifies the user's credentials on the remote server. It is relevant only when the never-bind flag is enabled. When this attribute is omitted the default value \"userPassword\" is used instead. ",
            "readOnly":false,
            "default":"userPassword",
            "type":"string"
        },
        "ds-cfg-use-proxy-auth":{
            "description":"This flag indicates whether the LDAP connector can use the proxy authorization control. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-include-list":{
            "description":"The list contains a set of DNs. If the client bind DN is a descendant of one of the DNs in the list, or if the list is empty, then the client credentials can be used to perform authentication against the remote server (as long as the client bind DN is not a descendant of any DN on the exclude list). If the never-bind flag is disabled then a silent-bind is performed for the authentication. If the never-bind flag is enabled, the user's entry is retrieved from the remote server and the credentials are checked locally. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-client-cred-mode":{
            "description":"Specifies the way the proxy server binds to the remote LDAP server. ",
            "readOnly":false,
            "type":"string",
            "enum":[
                "use-client-identity",
                "use-proxy-auth",
                "use-specific-identity"
            ]
        },
        "ds-cfg-remote-ldap-server-bind-password-file":{
            "description":"File which contains the password which will be used to connect to the remote server. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-remote-ldap-server-bind-password":{
            "description":"Password which will be used to connect to the remote server. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-remote-root-password":{
            "description":"Password which will be used by the root DN to connect to the remote server. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-ldap-server-extension":{
            "description":"Identifies the LDAP server extension configured for this Proxy LDAP Workflow Element. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-search-count-limit":{
            "description":"The default size limit value used in the ldapsearch request, when it is not specified in the client request or when a size limit of zero has been specified in the client request. ",
            "readOnly":false,
            "default":"0",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-remote-root-dn":{
            "description":"The root DN which will be used to perform internal operations on a remote server. This DN must exist on the remote server. The value \"\" denotes the anonymous credentials. If \"\" is provided then the remote-ldap-server-bind-password property is ignored. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-log-silent-bind-response-controls":{
            "description":"Indicates whether the logging of the silent-bind response controls is enabled. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-exclude-list":{
            "description":"The list contains a set of DNs. If the client bind DN is a descendant of one DNs on the exclude list, then the authentication against the remote server will be performed using the proxy credentials, regardless of the content of the include list. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: ds-cfg-exclude-list

型: array

このリストには一連のDNが含まれています。クライアント・バインドDNが除外リスト上のいずれかのDNの子である場合、包含リストの内容に関係なく、リモート・サーバーに対する認証はプロキシ資格証明を使用して実行されます。

ソースを表示

• 配列: 文字列

{
    "description":"The list contains a set of DNs. If the client bind DN is a descendant of one DNs on the exclude list, then the authentication against the remote server will be performed using the proxy credentials, regardless of the content of the include list. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-include-list

型: array

このリストには一連のDNが含まれています。クライアント・バインドDNがリスト上のいずれかのDNの子である場合、またはリストが空である場合、リモート・サーバーに対する認証を実行するためにクライアント資格証明を使用できます(クライアント・バインドDNが除外リスト上のいずれかのDNの子である場合を除きます)。never-bindフラグが無効になっている場合は、認証に対してサイレント・バインドが実行されます。never-bindフラグが有効になっている場合は、ユーザーのエントリがリモート・サーバーから取得され、資格証明がローカルでチェックされます。

ソースを表示

• 配列: 文字列

{
    "description":"The list contains a set of DNs. If the client bind DN is a descendant of one of the DNs in the list, or if the list is empty, then the client credentials can be used to perform authentication against the remote server (as long as the client bind DN is not a descendant of any DN on the exclude list). If the never-bind flag is disabled then a silent-bind is performed for the authentication. If the never-bind flag is enabled, the user's entry is retrieved from the remote server and the credentials are checked locally. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

• 配列: 文字列

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

400レスポンス

ERROR

406レスポンス

受入れできません

本文 ()

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

• ldapErrorCode: integer(int32)
  操作に対して返されるLDAPエラー・コードを指定します。
• message(required): string
  操作に対して返されるエラー・メッセージ。
• msgType(required): string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

  RESTメッセージ・タイプ

{
    "type":"object",
    "required":[
        "msgType",
        "message"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse",
            "type":"string"
        },
        "message":{
            "description":"Error message returned returned for the operation.",
            "type":"string"
        },
        "ldapErrorCode":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the LDAP error code returned for the operation."
        }
    }
}

先頭に戻る