latestOpenAPI 3.0.02026-08-0819201.1 MB

411f9f98c01e

auth clients

Lists all auth clients

You need one of the global.auth_clients.get, tenants.auth_clients.get, contracts.auth_clients.get or workspaces.auth_clients.get permission to access this resource. Each permission allows to list auth clients in particular scope inclusively: global.auth_clients.get allows to list global clients, tenants.auth_clients.get allows to list global and tenant’s clients, contracts.auth_clients.get allows to list global, tenant’s and all tenant’s contracts clients, workspaces.auth_clients.get allows to list all global, tenant’s, contracts’ and workspaces’ clients.

get/auth-clients

Query parameters

filter[component]string

Filter the auth clients only for specific component. Must be identifier of component

workspace_idstring

Show auth clients available in the given workpspace (including contract’s, tenant’s and global auth-clients). Only one of workspace_id, contract_id, tenant_id can be specified at time. If none these of parameters is specified only global clients will be returned.

contract_idstring

Show Auth Clients available in the given contract (including tenant’s and global auth-clients).

tenant_idstring

Show Auth Clients available in the given tenant and global scope.

Response

OK

metaobject required

Example response

{
  "data": [
    {
      "id": "5b4f337bff4304610483ba67",
      "links": {
        "self": "/v2/auth-clients/5b4f337bff4304610483ba67"
      },
      "attributes": {
        "name": "Auth client name",
        "credentials": {
          "client_id": "327193566714-99k85u8op9i10upjf8raus0aqjmtj.apps.googleusercontent.com",
          "client_secret": "wryIpa3vltT4GttJOQSKo3eo",
          "refresh_token_uri": "https://www.googleapis.com/oauth2/v4/token",
          "token_uri": "https://www.googleapis.com/oauth2/v4/token",
          "auth_uri": "https://www.googleapis.com/oauth2/v2/auth"
        }
      },
      "relationships": {
        "components": {
          "data": [
            {
              "id": "5b4f337bff4304610483ba67"
            }
          ]
        },
        "workspace": {
          "data": {
            "id": "5b4f337bff4304610483ba67"
          },
          "links": {
            "self": "/v2/workspaces/5b4f337bff4304610483ba67"
          }
        }
      }
    }
  ]
}