Jump to

• Request
• Response

Find OAuth Resource Server by name or ID

get

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

Returns a Resource Server. The search can be done either with the name or the ID of the Resource Server. Only one of the query parameters needs to be specified.

Request

Supported Media Types

• application/json
• application/x-www-form-urlencoded

Query Parameters

• id(required): string
  Unique ID of the Resource Server
• identityDomainName(required): string
  Name of the Identity Domain under which the Resource Server exits
• name(required): string
  Name of the Resouce Server

Back to Top

Response

Supported Media Types

• application/json

200 Response

Sucessfully retrieved 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 retrive OAuth entity "ResourceServer" - name "NameofResourceServer"

Back to Top