Jump to

• Request
• Response

Get all authorization providers

get

https://{your_site_interface}/opa-hub/api/12.2.35/authorization-providers

This operation will get all authorization providers.

Request

Query Parameters

• expand: string
  Comma separated list of named resources to expand, or "all" to expand all
• fields: string
  Comma separated list of fields to be returned
• links: string
  Comma separated list of links to be returned, or "none" to omit links
• q: string
  A JSON object for filtering matching property values within the collection

There's no request body for this operation.

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The request was successfully completed.

Body ()

Root Schema : authorizationProviders

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/authorizationProvider"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : items

Type: array

Show Source

• Array of: object authorizationProvider

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/authorizationProvider"
    }
}

Nested Schema : authorizationProvider

Type: object

Show Source

• clientId(required): string
  The authorization provider's client ID for the target client application.
• clientSecret(required): string
  The authorization provider's client secret for the target client application.
• name(required): string
  The authorization provider's display name.
• scope(required): string
  The scope to use when authenticating with the client application.
• type(required): string
  Allowed Values: [ "interviews", "environment" ]

  The authorization provider's type.
• url(required): string
  The authorization provider's URL.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The authorization provider's display name."
        },
        "url":{
            "type":"string",
            "description":"The authorization provider's URL."
        },
        "scope":{
            "type":"string",
            "description":"The scope to use when authenticating with the client application."
        },
        "clientId":{
            "type":"string",
            "description":"The authorization provider's client ID for the target client application."
        },
        "clientSecret":{
            "type":"string",
            "description":"The authorization provider's client secret for the target client application."
        },
        "type":{
            "type":"string",
            "description":"The authorization provider's type.",
            "enum":[
                "interviews",
                "environment"
            ]
        }
    },
    "additionalProperties":false,
    "required":[
        "clientId",
        "scope",
        "name",
        "clientSecret",
        "type",
        "url"
    ]
}

Back to Top