ジャンプ先

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

DNによるOauthアイデンティティ・プロバイダの変更

PATCH

/rest/v1/admin/{dn}

DNによるOauthアイデンティティ・プロバイダの変更

リクエスト

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

• application/json

パス・パラメータ

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

本文 ()

変更する必要があるOauthアイデンティティ・プロバイダ

ルート・スキーマ: PatchRequest

型: object

ソースを表示

• controls(optional): array controls
  LDAP変更操作のためにサーバーに送信するLDAP制御。
• msgType: 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: string
  変更するエントリ属性。
• opType: string
  指定可能な値: [ "add", "delete", "replace", "increment" ]

  パッチ操作のタイプ。
• values(optional): 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

本文 ()

ルート・スキーマ: Oauthアイデンティティ・プロバイダのPatchSuccessResponse

型: object

ソースを表示

• msgType: string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse

  RESTメッセージ・タイプ
• searchResultEntries: array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• 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: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/Oauth Identity Provider SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト Oauthアイデンティティ・プロバイダのSearchResultEntry

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

ネストされたスキーマ: Oauthアイデンティティ・プロバイダのSearchResultEntry

型: object

ソースを表示

• attributes: object Oauthアイデンティティ・プロバイダのプロパティ
• 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/Oauth Identity Provider Properties"
        }
    }
}

ネストされたスキーマ: Oauthアイデンティティ・プロバイダのプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-enabled: boolean
  アイデンティティ・プロバイダが有効かどうかを示します。
• ds-cfg-identity-mapper: string
  アイデンティティ・マッパーのDNを指定します。
• ds-cfg-java-class: string
  デフォルト値: com.oracle.rest.OauthIdentityProvider

  Oauthアイデンティティ・プロバイダの実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-oauth-resource-server: string
  このディレクトリ・サーバーのOAuthリソース・サーバーURIを指定します。
• ds-cfg-oauth-scope: array ds-cfg-oauth-scope
  OAuthトークン・スコープを指定します。
• ds-cfg-oauth-token-issuer: string
  OAuthトークン発行者URLを指定します。
• ds-cfg-oauth-token-x5t-algorithm(optional): string
  デフォルト値: SHA1

  アイデンティティ・プロバイダのX.509証明書の拇印の生成に使用するアルゴリズムを指定します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-oauth-token-issuer",
        "ds-cfg-oauth-resource-server",
        "ds-cfg-identity-mapper",
        "ds-cfg-enabled",
        "ds-cfg-oauth-scope"
    ],
    "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 Oauth Identity Provider implementation. ",
            "readOnly":false,
            "default":"com.oracle.rest.OauthIdentityProvider",
            "type":"string"
        },
        "ds-cfg-oauth-token-issuer":{
            "description":"Specifies the OAuth token issuer URL. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-oauth-resource-server":{
            "description":"Specifies the OAuth resource server URI of this Directory Server. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-oauth-token-x5t-algorithm":{
            "description":"Specifies the algorithm used to generate the thumbprint of Identity Provider's X.509 certificate. ",
            "readOnly":false,
            "default":"SHA1",
            "type":"string"
        },
        "ds-cfg-identity-mapper":{
            "description":"Specifies the DN of Identity Mapper. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Identity Provider is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-oauth-scope":{
            "description":"Specifies the OAuth token scope. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

OAuthトークン・スコープを指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the OAuth token scope. ",
    "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(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."
        }
    }
}

先頭に戻る