ジャンプ先

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

DNによるRDBMSワークフロー要素の変更

PATCH

/rest/v1/admin/{dn}

DNによるRDBMSワークフロー要素の変更

リクエスト

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

• application/json

パス・パラメータ

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

本文 ()

変更する必要があるRDBMSワークフロー要素

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

本文 ()

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

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

型: array

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

ソースを表示

• 配列: オブジェクト RDBMSワークフロー要素のSearchResultEntry

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

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

型: object

ソースを表示

• attributes(required): object RDBMSワークフロー要素のプロパティ
• 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/RDBMS Workflow Element Properties"
        }
    }
}

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

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-cache-invalidation-interval: string
  デフォルト値: 60000ms

  キャッシュされたオブジェクトの保存期間。このプロパティは、キャッシュ無効化プロパティがttl-cache-invalidation-policyに設定されている場合に使用されます。
• ds-cfg-cache-invalidation-policy: string
  デフォルト値: no-expiry-cache-invalidation-policy

  指定可能な値: [ "no-expiry-cache-invalidation-policy", "ttl-cache-invalidation-policy" ]

  キャッシュされたデータを無効化するために使用する必要があるポリシー。
• ds-cfg-cache-size: integer(int32)
  デフォルト値: 1000

  キャッシュされるデータベース・レコード数。
• ds-cfg-caching-scheme: string
  デフォルト値: none

  指定可能な値: [ "full", "hard-weak", "none", "soft", "soft-weak", "weak" ]

  データベース・レコードをキャッシュするために使用する必要があるスキームを選択します。noneが、推奨されるデフォルトです。
• ds-cfg-enabled(required): boolean
  サーバーでワークフロー要素が使用可能かどうかを示します。
• ds-cfg-java-class(required): string
  デフォルト値: com.oracle.dps.server.workflowelement.rdbms.RDBMSWorkflowElement

  RDBMSワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-password-attribute: string
  ユーザー・パスワードの保持に使用する属性タイプを指定します。
• ds-cfg-password-storage-scheme: string
  このパスワード・ポリシーでクリア・テキスト・パスワードのエンコードに使用するパスワード記憶スキームの名前を指定します。
• ds-cfg-prefix-password-with-storage-scheme: boolean
  デフォルト値: false

  保存されているパスワードにスキーム名を接頭辞として付けるかどうかを指定します。
• ds-cfg-rdbms-extension(required): string
  RDBMS拡張機能には、データベースに接続するためのログイン詳細が含まれています。この拡張機能では、拡張機能を参照するすべてのワークフロー要素によって共有される接続プールが維持されます。
• ds-cfg-skip-dn-validation-attributes: array ds-cfg-skip-dn-validation-attributes
  構成された属性のDN検証はスキップされます
• ds-cfg-suffix(required): string
  このワークフロー要素によって格納されているすべてのエントリのサフィクスDN
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-suffix",
        "ds-cfg-enabled",
        "ds-cfg-rdbms-extension"
    ],
    "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 RDBMS Workflow Element implementation. ",
            "readOnly":false,
            "default":"com.oracle.dps.server.workflowelement.rdbms.RDBMSWorkflowElement",
            "type":"string"
        },
        "ds-cfg-password-storage-scheme":{
            "description":"Specifies the names of the password storage schemes that are used to encode clear-text passwords for this password policy. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-skip-dn-validation-attributes":{
            "description":"The DN validation will be skipped for the configured attributes ",
            "readOnly":false,
            "default":[
                "member",
                "isMemberOf",
                "owner",
                "uniqueMember",
                "manager"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-cache-size":{
            "description":"The number of database records to be cached. ",
            "readOnly":false,
            "default":"1000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-password-attribute":{
            "description":"Specifies the attribute type used to hold user passwords. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-cache-invalidation-policy":{
            "description":"The policy that must be used to invalidate the cached data. ",
            "readOnly":false,
            "default":"no-expiry-cache-invalidation-policy",
            "type":"string",
            "enum":[
                "no-expiry-cache-invalidation-policy",
                "ttl-cache-invalidation-policy"
            ]
        },
        "ds-cfg-prefix-password-with-storage-scheme":{
            "description":"Specifies if passwords stored should be prefixed with scheme name or not. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-cache-invalidation-interval":{
            "description":"The lifetime of cached objects. This property is used when the cache invalidation property is set to 'ttl-cache-invalidation-policy'. ",
            "readOnly":false,
            "default":"60000ms",
            "type":"string"
        },
        "ds-cfg-caching-scheme":{
            "description":"Select the scheme that must be used to cache database records. \"none\" is the recommended default. ",
            "readOnly":false,
            "default":"none",
            "type":"string",
            "enum":[
                "full",
                "hard-weak",
                "none",
                "soft",
                "soft-weak",
                "weak"
            ]
        },
        "ds-cfg-suffix":{
            "description":"suffix DN of all entries stored by this 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-rdbms-extension":{
            "description":"An RDBMS Extension contains the login details for connecting to the database. The Extension maintains a Connection Pool which is shared by all workflow elements referencing the extension. ",
            "readOnly":false,
            "type":"string"
        }
    }
}

ネストされたスキーマ: ds-cfg-skip-dn-validation-attributes

型: array

構成された属性のDN検証はスキップされます

デフォルト値: [ "member", "isMemberOf", "owner", "uniqueMember", "manager" ]

ソースを表示

• 配列: 文字列

{
    "description":"The DN validation will be skipped for the configured attributes ",
    "readOnly":false,
    "default":[
        "member",
        "isMemberOf",
        "owner",
        "uniqueMember",
        "manager"
    ],
    "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."
        }
    }
}

先頭に戻る