Jump to

• Request
• Response

Find OAuth Client by name or ID

get

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

Returns an OAuth Client. The search can be done either with the name or the ID of the Client. Only one of the query parameters needs to be specified.

Request

Supported Media Types

• application/json

Query Parameters

• id: string
  ClientID of the client
• identityDomainName: string
  Name of the Identity Domain under which the Client exits
• name: string
  Name of the Client

Response

Supported Media Types

• application/json

200 Response

Sucessfully retrieved entity - OAuthClient, detail

Body ()

Root Schema : Client

Type: object

Show Source

• attributes: array attributes
• clientType: string
  Allowed Values: [ "CONFIDENTIAL_CLIENT", "PUBLIC_CLIENT", "MOBILE_CLIENT" ]

  Type of the client
• description: string
• grantTypes: array grantTypes
• id: string
  ClientID for the client. Will be auto generated if not specified
• idDomain: string
  Name of the Identity Domain under which the Client exists
• name: string
  Name of the Client
• redirectURIs: array redirectURIs
• scopes: array scopes
• secret: string
  Password for the client if confidential

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the Client"
        },
        "description":{
            "type":"string"
        },
        "idDomain":{
            "type":"string",
            "description":"Name of the Identity Domain under which the Client exists"
        },
        "id":{
            "type":"string",
            "description":"ClientID for the client. Will be auto generated if not specified"
        },
        "secret":{
            "type":"string",
            "description":"Password for the client if confidential"
        },
        "clientType":{
            "type":"string",
            "description":"Type of the client",
            "enum":[
                "CONFIDENTIAL_CLIENT",
                "PUBLIC_CLIENT",
                "MOBILE_CLIENT"
            ]
        },
        "grantTypes":{
            "type":"array",
            "xml":{
                "name":"grantTypes",
                "wrapped":true
            },
            "items":{
                "type":"string",
                "enum":[
                    "PASSWORD",
                    "REFRESH_TOKEN",
                    "JWT_BEARER",
                    "CLIENT_CREDENTIALS",
                    "AUTHORIZATION_CODE"
                ]
            }
        },
        "scopes":{
            "type":"array",
            "xml":{
                "name":"scopes",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/ScopeSettings"
            }
        },
        "redirectURIs":{
            "type":"array",
            "xml":{
                "name":"redirectURIs",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/RedirectURI"
            }
        },
        "attributes":{
            "type":"array",
            "xml":{
                "name":"attributes",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/TokenAttributeSettings"
            }
        }
    }
}

Nested Schema : attributes

Type: array

Show Source

• [0]: object TokenAttributeSettings
  Custom attributes that can be added to the Access Token

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

Nested Schema : grantTypes

Type: array

Show Source

• [0]: string
  Allowed Values: [ "PASSWORD", "REFRESH_TOKEN", "JWT_BEARER", "CLIENT_CREDENTIALS", "AUTHORIZATION_CODE" ]

{
    "type":"array",
    "xml":{
        "name":"grantTypes",
        "wrapped":true
    },
    "items":{
        "type":"string",
        "enum":[
            "PASSWORD",
            "REFRESH_TOKEN",
            "JWT_BEARER",
            "CLIENT_CREDENTIALS",
            "AUTHORIZATION_CODE"
        ]
    }
}

Nested Schema : redirectURIs

Type: array

Show Source

• [0]: object RedirectURI

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

Nested Schema : scopes

Type: array

Show Source

• [0]: object ScopeSettings

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

Nested Schema : TokenAttributeSettings

Type: object

Custom attributes that can be added to the Access Token

Show Source

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

  Type of the Attribute
• attrValue: 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"
            ]
        }
    }
}

Nested Schema : RedirectURI

Type: object

Show Source

• isHttps: boolean
  Default Value: true
• url: string
  Redirect URL

{
    "type":"object",
    "required":[
        "url"
    ],
    "properties":{
        "url":{
            "type":"string",
            "description":"Redirect URL"
        },
        "isHttps":{
            "type":"boolean",
            "default":"true"
        }
    }
}

Nested Schema : ScopeSettings

Type: object

Show Source

• scopeName: string
  Name of the scope

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

422 Response

Failed to retrive OAuth entity "Client" - name "NameofClient"