Skip to main content

OIDC providers

OpenID Connect providers portal users sign in with ("Sign in with..."). test create fetches the issuer's discovery document to validate the URL before the provider is saved.

CommandHTTPDescription
portal-oauth-providers listGET /v1/portal_oauth_providersList OIDC providers
portal-oauth-providers createPOST /v1/portal_oauth_providersAdd OIDC provider
portal-oauth-providers updatePATCH /v1/portal_oauth_providers/{id}Update OIDC provider
portal-oauth-providers deleteDELETE /v1/portal_oauth_providers/{id}Delete OIDC provider
portal-oauth-providers test createPOST /v1/portal_oauth_providers/testTest OIDC issuer

Examples​

--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# List OIDC providers
kobana dashboards portal-oauth-providers list

# Test OIDC issuer
kobana dashboards portal-oauth-providers test create \
  --json '{"issuer_url": "https://accounts.google.com"}'

# Add OIDC provider
kobana dashboards portal-oauth-providers create \
  --json '{"name": "Google", "issuer_url": "https://accounts.google.com", "client_id": "CLIENT_ID", "client_secret": "CLIENT_SECRET"}'

# Update OIDC provider
kobana dashboards portal-oauth-providers update \
  --params '{"id": "PROVIDER_ID"}' \
  --json '{"enabled": false}'

Next steps​