Jump to

• Request
• Response

Update an existing OAuth Resource Server either based on the name of the resource server or the ID of the resource server.

put

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

Either "name" or "id" query parameters need to be passed to modify the existing resource server

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• id(required): string
  ID of the Resource Server
• name(required): string
  Name of the Resource Server

Body ()

Resource Server that needs to be modified

Root Schema : ResourceServer

Type: object

Show Source

• description: string
• idDomain(required): string
  Name of the Identity Domain under which the resource server is created
• name(required): string
  Name of the Resource Server
• scopes(required): array scopes
• tokenAttributes: 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"
            }
        }
    }
}

Nested Schema : scopes

Type: array

Show Source

• Array of: object ScopeSettings

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

Nested Schema : tokenAttributes

Type: array

Show Source

• Array of: object AttributeSettings
  Custom attributes that can be added to the Access Token

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

Nested Schema : ScopeSettings

Type: object

Show Source

• scopeName(required): string
  Name of the scope

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

Nested Schema : AttributeSettings

Type: object

Custom attributes that can be added to the Access Token

Show Source

• attrName(required): string
  Name of the custom attribute
• attrType(required): string
  Allowed Values: [ "STATIC", "DYNAMIC" ]

  Type of the Attribute
• attrValue(required): string
  Value of the custom attribute. This could be a static value or a dynamic one that is evaluated and substituted.

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Sucessfully modified entity - OAuthResourceServer, detail

Body ()

Root Schema : ResourceServer

Type: object

Show Source

• description: string
• idDomain(required): string
  Name of the Identity Domain under which the resource server is created
• name(required): string
  Name of the Resource Server
• scopes(required): array scopes
• tokenAttributes: 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"
            }
        }
    }
}

Nested Schema : scopes

Type: array

Show Source

• Array of: object ScopeSettings

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

Nested Schema : tokenAttributes

Type: array

Show Source

• Array of: object AttributeSettings
  Custom attributes that can be added to the Access Token

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

Nested Schema : ScopeSettings

Type: object

Show Source

• scopeName(required): string
  Name of the scope

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

Nested Schema : AttributeSettings

Type: object

Custom attributes that can be added to the Access Token

Show Source

• attrName(required): string
  Name of the custom attribute
• attrType(required): string
  Allowed Values: [ "STATIC", "DYNAMIC" ]

  Type of the Attribute
• attrValue(required): string
  Value of the custom attribute. This could be a static value or a dynamic one that is evaluated and substituted.

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

Failed to update OAuth entity "ResourceServer" - name "NameofResourceServer"

Back to Top