Releasesv0.1.0
Api referenceEndpointsAdmin

Every provider of this build and how it stands (instance admin)

GET
/v1/admin/providers

Only a key of the instance admin tenant may call it (403 otherwise; ohs admin tenant list shows which tenant that is). Provider keys are instance wide: every tenant's users connect through the same provider apps. Secret keys are never served, only whether they are set. public_url is false while OHS_PUBLIC_URL is unset: the redirect and notification URLs then name localhost, which no provider can reach.

Authorization

tenantKey
headerAuthorizationBearer <token>

Tenant API key, ohs_sk_ + 43 base62 characters.

Header Parameters

Authorization*string

The tenant API key, as a bearer secret.

Response Body

The providers.

application/json
  1. response
data*array<>
public_url*boolean
curl -X GET 'http://localhost:8080/v1/admin/providers' \  -H 'Authorization: Bearer ohs_sk_...'
{  "data": [    {      "slug": "string",      "name": "string",      "kinds": [        "oauth"      ],      "status": "active",      "enabled": true,      "source": "env",      "keys": [        {          "name": "CLIENT_ID",          "env": "OHS_OURA_CLIENT_ID",          "required": true,          "secret": true,          "set": true,          "value": "string"        }      ],      "error": "string",      "urls": {        "redirect": "string",        "inbound": "string"      },      "updated_at": "2019-08-24T14:15:22Z",      "updated_by": "string"    }  ],  "public_url": true}
Edit on GitHub