Sign in
latestOpenAPI 3.0.02026-08-0819201.1 MB

411f9f98c01e

auth clients

Update the specified auth client

You have to be a member with appropriate permission to access this resource. This resource allows you to update the auth client. If the auth client with type oauth2 then you can update name, client_secret, token_expires_in and linked components, otherwise if the type is other, then you can put in credentials any data that you want and add components which can use this auth client.

patch/auth-clients/{auth-client_id}

Path parameters

auth-client_idstring required

Auth client identifier

Request body

Example request

{
  "data": {
    "id": "5b4f337bff4304610483ba67",
    "attributes": {
      "name": "Auth client name",
      "credentials": {
        "client_secret": "wryIpa3vltT4GttJOQSKo3eo"
      }
    },
    "relationships": {
      "components": {
        "data": [
          {
            "id": "5b4f337bff4304610483ba67"
          }
        ]
      }
    }
  }
}

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