Guest Machines
DevelopersApi referenceAuthentication

List available integrations

GET/api/v1/oauth-clients/available

List active integrations available to the signed-in member, including that member's current consent status.

Required access

Credentials: user session

This supports the human consent step and cannot be called with an integration credential.

Authorization

UserSession
AuthorizationBearer <token>

A short-lived bearer token for a signed-in person. Use it only for the human integration-installation and consent steps; never store it as an integration credential.

In: header

Header Parameters

X-Org-Id?|

Selects the active organization for a direct user session that has more than one membership. Service-principal keys and delegated tokens are each bound to one organization and ignore it.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/oauth-clients/available" \  -H "Authorization: Bearer $GUEST_MACHINES_API_KEY"
[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "allowed_scopes": [      "string"    ],    "created_at": "2019-08-24T14:15:22Z",    "my_grant": {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "oauth_client_id": "727760ca-b97d-449c-90e5-7773c8142d5d",      "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",      "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",      "scopes": [        "string"      ],      "status": "active",      "granted_at": "2019-08-24T14:15:22Z",      "revoked_at": "2019-08-24T14:15:22Z"    }  }]
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}
{  "detail": "string",  "error_code": "string",  "request_id": "string"}