Api referenceEndpointsAdmin
Create a link to the hosted connection page (instance admin, one tenant)
POST
POST /v1/users/{id}/connect-sessions (createConnectSession) for the tenant of tenant_id, run with an
instance admin key: the same body, parameters and answer as the tenant's own key
gets; a Location points at the admin route. Recorded in the caller's audit log
and, actor admin, in the tenant's.
See docs/admin-api.md.
tenantKeyheader
AuthorizationBearer <token>Tenant API key, ohs_sk_ + 43 base62 characters.
tenant_id*stringThe id of a tenant; any other value is a 404.
Format
uuidid*stringFormat
uuidapplication/json- body
redirect_uri?stringWhere the user lands after each consent. Absolute https URL (http only for localhost).
Format
uriLength
length <= 2048providers?array<string>Provider slugs the page offers, in this order. Each must be an OAuth provider enabled on this instance. Default, every one.
Items
items <= 64app_name?stringShown as the page title.
Length
length <= 80logo_url?stringAn https image shown above the title.
Format
uriLength
length <= 2048ttl_seconds?integerRange
60 <= value <= 3600Default
1800The page link.
application/json- response
url*string<OHS_PUBLIC_URL>/connect?session=<token>
Format
uriexpires_at*stringFormat
date-timecurl -X POST 'http://localhost:8080/v1/admin/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/connect-sessions' \ -H 'Authorization: Bearer ohs_sk_...' \ -H 'Content-Type: application/json' \ -d '{}'{ "url": "http://example.com", "expires_at": "2019-08-24T14:15:22Z"}