ジャンプ先

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

リソース・サーバーの名前またはリソース・サーバーのIDに基づいて、既存のOAuthリソース・サーバーを更新します。

put

/oam/services/rest/ssa/api/v1/oauthpolicyadmin/application

既存のリソース・サーバーを変更するには、"name"または"id"問合せパラメータを渡す必要があります

リクエスト

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

• application/json
• application/xml

問合せパラメータ

• id: string
  リソース・サーバーのID
• name: string
  リソース・サーバーの名前

本文()

変更する必要があるリソース・サーバー

ルート・スキーマ: ResourceServer

型: object

ソースを表示

• description(optional): string
• idDomain: string
  リソース・サーバーが作成されるアイデンティティ・ドメインの名前
• name: string
  リソース・サーバーの名前
• scopes: array scopes
• tokenAttributes(optional): array tokenAttributes

{
    "type":"object",
    "required":[
        "name",
        "idDomain",
        "scopes"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Resource Server"
        },
        "description":{
            "type":"string"
        },
        "idDomain":{
            "type":"string",
            "description":"Name of the Identity Domain under which the resource server is created"
        },
        "scopes":{
            "type":"array",
            "xml":{
                "name":"scopes",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/ScopeSettings"
            }
        },
        "tokenAttributes":{
            "type":"array",
            "xml":{
                "name":"tokenAttributes",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/AttributeSettings"
            }
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト ScopeSettings

{
    "type":"array",
    "xml":{
        "name":"scopes",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/ScopeSettings"
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト AttributeSettings
  アクセス・トークンに追加できるカスタム属性

{
    "type":"array",
    "xml":{
        "name":"tokenAttributes",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/AttributeSettings"
    }
}

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

型: object

ソースを表示

• scopeName: string
  スコープの名前

{
    "type":"object",
    "required":[
        "scopeName"
    ],
    "properties":{
        "scopeName":{
            "type":"string",
            "description":"Name of the scope"
        }
    }
}

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

型: object

アクセス・トークンに追加できるカスタム属性

ソースを表示

• attrName: string
  カスタム属性の名前
• attrType: string
  指定可能な値: [ "STATIC", "DYNAMIC" ]

  属性のタイプ
• attrValue: string
  カスタム属性の値。これは評価および置換される静的値または動的値になる可能性があります。

{
    "type":"object",
    "description":"Custom attributes that can be added to the Access Token",
    "required":[
        "attrName",
        "attrValue",
        "attrType"
    ],
    "properties":{
        "attrName":{
            "type":"string",
            "description":"Name of the custom attribute"
        },
        "attrValue":{
            "type":"string",
            "description":"Value of the custom attribute. This could be a static value or a dynamic one that is evaluated and substituted."
        },
        "attrType":{
            "type":"string",
            "description":"Type of the Attribute",
            "enum":[
                "STATIC",
                "DYNAMIC"
            ]
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

200 レスポンス

エンティティ - OAuthResourceServer、詳細を正常に変更しました

本文()

ルート・スキーマ: ResourceServer

型: object

ソースを表示

• description(optional): string
• idDomain: string
  リソース・サーバーが作成されるアイデンティティ・ドメインの名前
• name: string
  リソース・サーバーの名前
• scopes: array scopes
• tokenAttributes(optional): array tokenAttributes

{
    "type":"object",
    "required":[
        "name",
        "idDomain",
        "scopes"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Resource Server"
        },
        "description":{
            "type":"string"
        },
        "idDomain":{
            "type":"string",
            "description":"Name of the Identity Domain under which the resource server is created"
        },
        "scopes":{
            "type":"array",
            "xml":{
                "name":"scopes",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/ScopeSettings"
            }
        },
        "tokenAttributes":{
            "type":"array",
            "xml":{
                "name":"tokenAttributes",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/AttributeSettings"
            }
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト ScopeSettings

{
    "type":"array",
    "xml":{
        "name":"scopes",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/ScopeSettings"
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト AttributeSettings
  アクセス・トークンに追加できるカスタム属性

{
    "type":"array",
    "xml":{
        "name":"tokenAttributes",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/AttributeSettings"
    }
}

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

型: object

ソースを表示

• scopeName: string
  スコープの名前

{
    "type":"object",
    "required":[
        "scopeName"
    ],
    "properties":{
        "scopeName":{
            "type":"string",
            "description":"Name of the scope"
        }
    }
}

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

型: object

アクセス・トークンに追加できるカスタム属性

ソースを表示

• attrName: string
  カスタム属性の名前
• attrType: string
  指定可能な値: [ "STATIC", "DYNAMIC" ]

  属性のタイプ
• attrValue: string
  カスタム属性の値。これは評価および置換される静的値または動的値になる可能性があります。

{
    "type":"object",
    "description":"Custom attributes that can be added to the Access Token",
    "required":[
        "attrName",
        "attrValue",
        "attrType"
    ],
    "properties":{
        "attrName":{
            "type":"string",
            "description":"Name of the custom attribute"
        },
        "attrValue":{
            "type":"string",
            "description":"Value of the custom attribute. This could be a static value or a dynamic one that is evaluated and substituted."
        },
        "attrType":{
            "type":"string",
            "description":"Type of the Attribute",
            "enum":[
                "STATIC",
                "DYNAMIC"
            ]
        }
    }
}

422 レスポンス

OAuthエンティティ"ResourceServer" - 名前"NameofResourceServer"の更新に失敗しました

先頭に戻る