ジャンプ先

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

DNによるパス・スルー認証ワークフロー要素の変更

PATCH

/rest/v1/admin/{dn}

DNによるパス・スルー認証ワークフロー要素の変更

リクエスト

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

• application/json

パス・パラメータ

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

本文 ()

変更する必要があるパス・スルー認証ワークフロー要素

ルート・スキーマ: 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

本文 ()

ルート・スキーマ: パス・スルー認証ワークフロー要素の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/Pass Through Authentication Workflow Element SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト パス・スルー認証ワークフロー要素のSearchResultEntry

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

ネストされたスキーマ: パス・スルー認証ワークフロー要素のSearchResultEntry

型: object

ソースを表示

• attributes(required): object パス・スルー認証ワークフロー要素のプロパティ
• 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/Pass Through Authentication Workflow Element Properties"
        }
    }
}

ネストされたスキーマ: パス・スルー認証ワークフロー要素のプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-auth-provider-workflow-element(required): string
  パス・スルー認証ワークフロー要素が取得するユーザー・エントリの認証サービスを提供するワークフロー要素を識別します。
• ds-cfg-enabled(required): boolean
  サーバーでワークフロー要素が使用可能かどうかを示します。
• ds-cfg-java-class(required): string
  デフォルト値: org.opends.server.workflowelement.pta.PassThroughAuthenticationWorkflowElement

  パス・スルー認証ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-password-attribute: string
  デフォルト値: userPassword

  ローカルにパスワードを含む属性の名前を指定します。
• ds-cfg-pta-auth-suffix: string
  認証プロバイダ・ワークフロー要素により公開される実際のベースDN
• ds-cfg-pta-join-rule: string
  ユーザー・プロバイダ・ワークフロー要素と認証プロバイダ・ワークフロー要素の間に定義された結合ルール。これは各コンポーネントの形式がauth.[attributeName]=user.[attributeName]で、AND/OR/NOTと組み合せられた複数のコンポーネントを含むLDAPFilter構文の一部です。このパラメータが設定されていない場合、PTAワークフロー要素によって、ユーザー・エントリと認証エントリのDNが同じであるとみなされます。
• ds-cfg-pta-suffix: string
  PTAワークフロー要素によって公開される仮想DN
• ds-cfg-pta-user-suffix: string
  ユーザー・プロバイダ・ワークフロー要素により公開される実際のベースDN
• ds-cfg-save-password-on-successful-bind: boolean
  デフォルト値: false

  認証が成功したときにパスワードをユーザー・エントリに保存するかどうかを示します。
• ds-cfg-user-provider-workflow-element(required): string
  リクエストされたユーザー・エントリを提供するワークフロー要素を識別します。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-auth-provider-workflow-element",
        "ds-cfg-enabled",
        "ds-cfg-user-provider-workflow-element"
    ],
    "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 Pass Through Authentication Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.pta.PassThroughAuthenticationWorkflowElement",
            "type":"string"
        },
        "ds-cfg-pta-join-rule":{
            "description":"The join rule defined between the user provider and auth provider workflow elements. It is of the LDAPFilter syntax containing multiple components mixed with AND/OR/NOT, with each component of the form auth.[attributeName]=user.[attributeName]. If this parameter is not set, the PTA workflow element considers that the user entry and the authentication entry have the same DN. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-password-attribute":{
            "description":"Specifies the names of the attribute that contains the password locally. ",
            "readOnly":false,
            "default":"userPassword",
            "type":"string"
        },
        "ds-cfg-save-password-on-successful-bind":{
            "description":"Indicates whether the password should be saved in the user entry when authentication succeeds. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-auth-provider-workflow-element":{
            "description":"Identifies the workflow element that provides the authentication service for the user entry retreived by this Pass Through Authentication Workflow Element. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-pta-suffix":{
            "description":"The virtual DN that will be exposed by the PTA Workflow Element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-pta-auth-suffix":{
            "description":"The real base DN that is exposed by the auth provider workflow element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-pta-user-suffix":{
            "description":"The real base DN that is exposed by the user provider workflow element ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-user-provider-workflow-element":{
            "description":"Identifies the workflow element that is responsible for providing the requested user entry. ",
            "readOnly":false,
            "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."
        }
    }
}

先頭に戻る