/api/v1/oauth/consent (GET)

GET

/api/v1/oauth/consent

const url = 'https://example.com/api/v1/oauth/consent?client_id=example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/v1/oauth/consent?client_id=example'

Parameters

Query Parameters

client_id

required

string

>= 1 characters <= 400 characters

scope

string

<= 400 characters

Responses

200

Default Response

application/json

object

client

required

object

name

required

string

uri

required

string | null

requestedScopes

required

Array<string>

locations

required

Array<object>

object

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

string

kind

required

string

role

required

string

Allowed values: owner admin member viewer

canWrite

required

boolean

Example

{
  "locations": [
    {
      "role": "owner"
    }
  ]
}