Oracle Unified Directory管理REST API

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レスポンス

ルート・スキーマ: ネットワーク・グループの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/Network Group SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

配列: オブジェクトネットワーク・グループのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Network Group 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/Network Group Properties"
        }
    }
}

ネストされたスキーマ: ネットワーク・グループのプロパティ

型: object

ソースを表示

cn: string

エントリのCN (共通名)
ds-cfg-allowed-auth-method: array ds-cfg-allowed-auth-method

ネットワーク・グループへの接続を確立するためにクライアントが使用する必要がある一連の許可された認可方法を指定します。
ds-cfg-allowed-bind-dn: array ds-cfg-allowed-bind-dn

ネットワーク・グループへの接続の確立を許可されているクライアントを判別する一連のバインドDNパターンを指定します。
ds-cfg-allowed-bind-id: array ds-cfg-allowed-bind-id

ネットワーク・グループへの接続の確立を許可されているクライアントを判別する一連のバインドidパターンを指定します。
ds-cfg-allowed-client: array ds-cfg-allowed-client

ネットワーク・グループへの接続の確立を許可されているクライアントを判別するためのホスト名またはアドレス・マスクのセットを指定します。
ds-cfg-allowed-port: array ds-cfg-allowed-port

ネットワーク・グループへの接続を確立するためにクライアントが使用する必要がある一連の許可されたポート番号を指定します。
ds-cfg-allowed-protocol: array ds-cfg-allowed-protocol

ネットワーク・グループへの接続を確立するためにクライアントが使用する必要がある一連の許可されたサポートされているプロトコルを指定します。
ds-cfg-certificate-mapper: string

クライアント証明書をユーザー・エントリと照合するときに使用する証明書マッパーの名前を指定します。
ds-cfg-denied-client: array ds-cfg-denied-client

ネットワーク・グループへの接続の確立を許可されていないクライアントを判別するためのホスト名またはアドレス・マスクのセットを指定します。
ds-cfg-enabled(required): boolean

ネットワーク・グループがサーバーで使用できるかどうかを示します。
ds-cfg-generic-identity-mapper: array ds-cfg-generic-identity-mapper

SIMPLEの非GSSAPI SASLバインド・リクエストおよびプロキシ認可制御の実行中にアイデンティティをマップするためにネットワーク・グループが使用するアイデンティティ・マッパーのセットを指定します。
ds-cfg-gssapi-identity-mapper: array ds-cfg-gssapi-identity-mapper

GSSAPI/SASLバインド・リクエストの実行中にアイデンティティをマップするためにネットワーク・グループが使用するアイデンティティ・マッパーのセットを指定します。
ds-cfg-is-security-mandatory: boolean

デフォルト値: false

クライアントがネットワーク・グループへの接続を確立するためにセキュアなクライアント接続が必要かどうかを指定します。
ds-cfg-priority(required): integer(int32)

ネットワーク・グループの優先度を指定します。
ds-cfg-relocated-rootdse-dn: string

デフォルト値:

ルートDSEを含むエントリのDNを指定します。パラメータが定義されていない場合(デフォルト)、null接尾辞("")が使用されます。
ds-cfg-relocated-rootdse-workflow-element: string

再配置されたルートDSEエントリを取得するために使用するワークフロー要素の名前を指定します。パラメータが定義されていない場合(デフォルト)、現在のサーバーのルートDSEエントリが返されます。
ds-cfg-workflow: array ds-cfg-workflow

ネットワーク・グループからアクセスできる必要があるワークフローのセットを指定します。
objectclass(required): array objectclass

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-priority",
        "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-allowed-bind-id":{
            "description":"Specifies a set of bind id patterns that determine the clients that are allowed to establish connections to this Network Group. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allowed-port":{
            "description":"Specifies a set of allowed port numbers that clients must use in order to establish connections to this Network Group. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-workflow":{
            "description":"Specifies a set of workflows which should be accessible from this Network Group . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-relocated-rootdse-workflow-element":{
            "description":"Specifies the name of the workflow element to use to get a relocated root DSE entry. If the parameter is not defined (default) then the root DSE entry of the current server is returned. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-generic-identity-mapper":{
            "description":"Specifies a set of identity mappers that will be used by Network Group for mapping an identity while performing SIMPLE, non-GSSAPI SASL bind requests and proxy authorization controls. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-certificate-mapper":{
            "description":"Specifies the name of the certificate mapper that should be used to match client certificates to user entries. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-priority":{
            "description":"Specifies the priority for this Network Group. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Network Group is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-gssapi-identity-mapper":{
            "description":"Specifies a set of identity mappers that will be used by Network Group for mapping an identity while performing GSSAPI/SASL bind requests. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-allowed-bind-dn":{
            "description":"Specifies a set of bind DN patterns that determine the clients that are allowed to establish connections to this Network Group. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-denied-client":{
            "description":"Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Network Group. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-is-security-mandatory":{
            "description":"Specifies whether or not a secured client connection is required in order for clients to establish connections to this Network Group. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-allowed-protocol":{
            "description":"Specifies a set of allowed supported protocols that clients must use in order to establish connections to this Network Group. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "ldap",
                "ldaps"
            ]
        },
        "ds-cfg-relocated-rootdse-dn":{
            "description":"Specifies the DN of the entry that contains the Root DSE. If the parameter is not defined (default) then the null suffix (\"\") is used. ",
            "readOnly":false,
            "default":"",
            "type":"string"
        },
        "ds-cfg-allowed-auth-method":{
            "description":"Specifies a set of allowed authorization methods that clients must use in order to establish connections to this Network Group. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "anonymous",
                "sasl",
                "simple"
            ]
        },
        "ds-cfg-allowed-client":{
            "description":"Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Network Group. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: ds-cfg-allowed-auth-method

型: array

ネットワーク・グループへの接続を確立するためにクライアントが使用する必要がある一連の許可された認可方法を指定します。

指定可能な値: [ "anonymous", "sasl", "simple" ]

ソースを表示

配列: 文字列

{
    "description":"Specifies a set of allowed authorization methods that clients must use in order to establish connections to this Network Group. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "anonymous",
        "sasl",
        "simple"
    ]
}

ネストされたスキーマ: ds-cfg-allowed-bind-dn

型: array

ネットワーク・グループへの接続の確立を許可されているクライアントを判別する一連のバインドDNパターンを指定します。

ソースを表示

配列: 文字列

{
    "description":"Specifies a set of bind DN patterns that determine the clients that are allowed to establish connections to this Network Group. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-allowed-bind-id

型: array

ネットワーク・グループへの接続の確立を許可されているクライアントを判別する一連のバインドidパターンを指定します。

ソースを表示

配列: 文字列

{
    "description":"Specifies a set of bind id patterns that determine the clients that are allowed to establish connections to this Network Group. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-allowed-client

型: array

ネットワーク・グループへの接続の確立を許可されているクライアントを判別するためのホスト名またはアドレス・マスクのセットを指定します。

ソースを表示

配列: 文字列

{
    "description":"Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Network Group. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-allowed-port

型: array

ネットワーク・グループへの接続を確立するためにクライアントが使用する必要がある一連の許可されたポート番号を指定します。

ソースを表示

配列: 文字列

{
    "description":"Specifies a set of allowed port numbers that clients must use in order to establish connections to this Network Group. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-allowed-protocol

型: array

ネットワーク・グループへの接続を確立するためにクライアントが使用する必要がある一連の許可されたサポートされているプロトコルを指定します。

指定可能な値: [ "ldap", "ldaps" ]

ソースを表示

配列: 文字列

{
    "description":"Specifies a set of allowed supported protocols that clients must use in order to establish connections to this Network Group. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "ldap",
        "ldaps"
    ]
}

ネストされたスキーマ: ds-cfg-denied-client

型: array

ネットワーク・グループへの接続の確立を許可されていないクライアントを判別するためのホスト名またはアドレス・マスクのセットを指定します。

ソースを表示

配列: 文字列

{
    "description":"Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Network Group. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-generic-identity-mapper

型: array

SIMPLEの非GSSAPI SASLバインド・リクエストおよびプロキシ認可制御の実行中にアイデンティティをマップするためにネットワーク・グループが使用するアイデンティティ・マッパーのセットを指定します。

ソースを表示

配列: 文字列

{
    "description":"Specifies a set of identity mappers that will be used by Network Group for mapping an identity while performing SIMPLE, non-GSSAPI SASL bind requests and proxy authorization controls. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-gssapi-identity-mapper

型: array

GSSAPI/SASLバインド・リクエストの実行中にアイデンティティをマップするためにネットワーク・グループが使用するアイデンティティ・マッパーのセットを指定します。

ソースを表示

配列: 文字列

{
    "description":"Specifies a set of identity mappers that will be used by Network Group for mapping an identity while performing GSSAPI/SASL bind requests. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

ネットワーク・グループからアクセスできる必要があるワークフローのセットを指定します。

ソースを表示

配列: 文字列

{
    "description":"Specifies a set of workflows which should be accessible from this Network Group . ",
    "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."
        }
    }
}

先頭に戻る