Sign in
latestOpenAPI 3.0.02026-08-0819201.1 MB

411f9f98c01e

auth clients

Creates an auth client

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. Scope where client is created is controlled by corresponding permission and relationship: workspace, contract or tenant. No relationship means that auth-client will be created in the global scope.

post/auth-clients

Request body

Example request

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

Response

Created

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