ジャンプ先

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

DNによるREST Webサービス拡張機能の変更

PATCH

/rest/v1/admin/{dn}

DNによるREST Webサービス拡張機能の変更

リクエスト

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

• application/json

パス・パラメータ

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

本文 ()

変更する必要があるREST Webサービス拡張機能

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

本文 ()

ルート・スキーマ: REST Webサービス拡張機能の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/REST Web Service Extension SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト REST Webサービス拡張機能のSearchResultEntry

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

ネストされたスキーマ: REST Webサービス拡張機能のSearchResultEntry

型: object

ソースを表示

• attributes(required): object REST Webサービス拡張機能のプロパティ
• 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/REST Web Service Extension Properties"
        }
    }
}

ネストされたスキーマ: REST Webサービス拡張機能のプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-authentication-schemes-documentation-url: string
  デフォルト値: http://www.oracle.com

  RESTful Webサービス認証スキームのドキュメントをホストするURLを指定します。
• ds-cfg-authentication-schemes-spec-url: string
  デフォルト値: http://www.oracle.com

  認証スキーム仕様のドキュメントをホストするURLを指定します。
• ds-cfg-bulk-max-operations: integer(int32)
  デフォルト値: 1000

  許容できるバルク操作の最大数を指定します。REST Webサービス拡張機能。
• ds-cfg-bulk-max-payload-size: integer(int32)
  デフォルト値: 1000

  REST Webサービス拡張機能を使用する際のバルク操作の最大ペイロード・サイズを指定します。
• ds-cfg-bulk-supported: boolean
  デフォルト値: true

  バルク操作がこのREST Webサービス拡張機能でサポートされるかどうか。
• ds-cfg-enabled(required): boolean
  拡張機能が使用可能かどうかを示します。
• ds-cfg-etag-supported: boolean
  デフォルト値: false

  EtagがこのREST Webサービス拡張機能でサポートされるかどうかを指定します。
• ds-cfg-filter-max-results: integer(int32)
  デフォルト値: 1000

  フィルタの使用時の最大結果サイズを指定します。REST Webサービス拡張機能。
• ds-cfg-filter-supported: boolean
  デフォルト値: true

  検索フィルタがWebサービスでサポートされるかどうかを指定します。REST Webサービス拡張機能。
• ds-cfg-java-class(required): string
  デフォルト値: com.oracle.scim.RESTWebServiceExtension

  REST Webサービス拡張機能の実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-patch-supported: boolean
  デフォルト値: true

  PATCH操作がWebサービスによってサポートされるかどうかを指定します。REST Webサービス拡張機能。
• ds-cfg-rest-context: string
  デフォルト値: /idaas/rest

  RESTful Webサービス・コンテキストを指定します。REST Webサービス拡張機能。
• ds-cfg-rest-documentation-url: string
  デフォルト値: http://www.oracle.com

  REST Webサービス拡張機能のドキュメントをホストするURLを指定します。
• ds-cfg-sort-supported: boolean
  デフォルト値: false

  検索結果のソートがこのREST Webサービス拡張機能でサポートされるかどうかを指定します。REST Webサービス拡張機能。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "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 REST Web Service Extension implementation. ",
            "readOnly":false,
            "default":"com.oracle.scim.RESTWebServiceExtension",
            "type":"string"
        },
        "ds-cfg-rest-documentation-url":{
            "description":"Specifies the URL hosting the documentation for REST Web Service Extension. ",
            "readOnly":false,
            "default":"http://www.oracle.com",
            "type":"string"
        },
        "ds-cfg-filter-max-results":{
            "description":"Specifies the maxium result size while using filters. REST Web Service Extension. ",
            "readOnly":false,
            "default":"1000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-bulk-max-payload-size":{
            "description":"Specifies the max payload size for the bulk operations while using REST Web Service Extension. ",
            "readOnly":false,
            "default":"1000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-filter-supported":{
            "description":"Specifies whether or not the Search filters will be supported by the web service. REST Web Service Extension. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Extension is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-patch-supported":{
            "description":"Specifies whether or not the PATCH operation is supported by the web service. REST Web Service Extension. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-rest-context":{
            "description":"Specifies the RESTful web service context. REST Web Service Extension. ",
            "readOnly":false,
            "default":"/idaas/rest",
            "type":"string"
        },
        "ds-cfg-bulk-max-operations":{
            "description":"Specifies the maximum number of allowable bulk operations. REST Web Service Extension. ",
            "readOnly":false,
            "default":"1000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-sort-supported":{
            "description":"Specifies whether or not the sorting of the search results is supported by this REST Web Service Extension. REST Web Service Extension. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-authentication-schemes-spec-url":{
            "description":"Specifies the URL hosting the documentation for authentication schemes specifications. ",
            "readOnly":false,
            "default":"http://www.oracle.com",
            "type":"string"
        },
        "ds-cfg-authentication-schemes-documentation-url":{
            "description":"Specifies the URL hosting the documentation for RESTful web services authentication schemes. ",
            "readOnly":false,
            "default":"http://www.oracle.com",
            "type":"string"
        },
        "ds-cfg-etag-supported":{
            "description":"Specifies whether or not the etag is supported by this REST Web Service Extension. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-bulk-supported":{
            "description":"Whether or not the bulk operations are supported by this REST Web Service Extension. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: 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."
        }
    }
}

先頭に戻る