Oracle Unified Directoryの管理REST API: ネットワーク・グループの追加、検索、比較または削除

ネットワーク・グループの追加、検索、比較または削除

POST

/rest/v1/admin

ネットワーク・グループの追加、検索、比較または削除

リクエスト

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

application/json

作成する必要があるネットワーク・グループ

ルート・スキーマ: ネットワーク・グループのPOSTRequest

型: object

ソースを表示

assertion(optional): string

LDAP比較操作用のアサーション文字列。注意: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
attributes(optional): object ネットワーク・グループのプロパティ
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である場合)にのみ使用します。

{
    "type":"object",
    "required":[
        "msgType"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "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"
            ]
        },
        "dn":{
            "description":"LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/Network Group Properties"
        },
        "base":{
            "description":"Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation",
            "type":"string"
        },
        "scope":{
            "description":"Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string",
            "enum":[
                "base",
                "sub",
                "one"
            ]
        },
        "filter":{
            "description":"Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string"
        },
        "requiredAttributes":{
            "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for the LDAP operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "assertion":{
            "description":"Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.",
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

cn(optional): string

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

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

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

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

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

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

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

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

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

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

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

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

デフォルト値: false

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

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

デフォルト値:

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

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

ネットワーク・グループからアクセスできる必要があるワークフローのセットを指定します。
objectclass: 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"
            }
        }
    }
}

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

型: array

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

ソースを表示

[0]: string

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

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

型: array

エントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。

ソースを表示

[0]: string

{
    "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

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

ソースを表示

[0]: string

{
    "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パターンを指定します。

ソースを表示

[0]: string

{
    "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パターンを指定します。

ソースを表示

[0]: string

{
    "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

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

ソースを表示

[0]: string

{
    "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

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

ソースを表示

[0]: string

{
    "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" ]

ソースを表示

[0]: string

{
    "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

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

ソースを表示

[0]: string

{
    "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バインド・リクエストおよびプロキシ認可制御の実行中にアイデンティティをマップするためにネットワーク・グループが使用するアイデンティティ・マッパーのセットを指定します。

ソースを表示

[0]: string

{
    "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バインド・リクエストの実行中にアイデンティティをマップするためにネットワーク・グループが使用するアイデンティティ・マッパーのセットを指定します。

ソースを表示

[0]: string

{
    "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

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

ソースを表示

[0]: string

{
    "description":"Specifies a set of workflows which should be accessible from this Network Group . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

[0]: string

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: ネットワーク・グループの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)

作成され、返されるエントリの数を指定します。

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "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"
            ]
        },
        "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"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

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

型: array

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

ソースを表示

[0]: object ネットワーク・グループのSearchResultEntry

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

ネストされたスキーマ: ネットワーク・グループのSearchResultEntry

型: object

ソースを表示

attributes: object ネットワーク・グループのプロパティ
dn: 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(optional): string

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

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

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

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

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

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

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

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

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

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

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

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

デフォルト値: false

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

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

デフォルト値:

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

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

ネットワーク・グループからアクセスできる必要があるワークフローのセットを指定します。
objectclass: 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" ]

ソースを表示

[0]: string

{
    "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パターンを指定します。

ソースを表示

[0]: string

{
    "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パターンを指定します。

ソースを表示

[0]: string

{
    "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

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

ソースを表示

[0]: string

{
    "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

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

ソースを表示

[0]: string

{
    "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" ]

ソースを表示

[0]: string

{
    "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

ソースを表示

[0]: string

{
    "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

ソースを表示

[0]: string

{
    "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

ソースを表示

[0]: string

{
    "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

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

ソースを表示

[0]: string

{
    "description":"Specifies a set of workflows which should be accessible from this Network Group . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

[0]: string

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

201レスポンス

作成済

ルート・スキーマ: ネットワーク・グループのADDResponse

型: object

ソースを表示

msgType: string

デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse

RESTメッセージ・タイプ
searchResultEntries: array searchResultEntries
totalResults: 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:AddResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Network Group SearchResultEntry"
            }
        }
    }
}

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

型: array

ソースを表示

[0]: object ネットワーク・グループのSearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Network Group SearchResultEntry"
    }
}

ネストされたスキーマ: ネットワーク・グループのSearchResultEntry

型: object

ソースを表示

attributes: object ネットワーク・グループのプロパティ
dn: 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(optional): string

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

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

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

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

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

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

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

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

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

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

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

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

デフォルト値: false

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

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

デフォルト値:

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

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

ネットワーク・グループからアクセスできる必要があるワークフローのセットを指定します。
objectclass: 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" ]

ソースを表示

[0]: string

{
    "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パターンを指定します。

ソースを表示

[0]: string

{
    "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パターンを指定します。

ソースを表示

[0]: string

{
    "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

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

ソースを表示

[0]: string

{
    "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

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

ソースを表示

[0]: string

{
    "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" ]

ソースを表示

[0]: string

{
    "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

ソースを表示

[0]: string

{
    "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

ソースを表示

[0]: string

{
    "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

ソースを表示

[0]: string

{
    "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

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

ソースを表示

[0]: string

{
    "description":"Specifies a set of workflows which should be accessible from this Network Group . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

[0]: string

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

204レスポンス

コンテンツがありません

406レスポンス

受入れできません

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

ldapErrorCode(optional): integer(int32)

操作に対して返されるLDAPエラー・コードを指定します。
message: string

操作に対して返されるエラー・メッセージ。
msgType: 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."
        }
    }
}

先頭に戻る