Read tenant authentication settings

Returns the tenant sign-in and multi-factor policy, identity provider connection metadata, and roles. Provider secrets are write-only; the response reports only whether a secret is configured.

Quire permissions

Required capability: auth/configure.

Credential scopes: tenants:read.

The acting subject must also be allowed to perform this action in the organisation.

GET

https://your-organisation.quirelms.com/api/v1/tenant_auth_settings

View as Markdown

Authorisation

apiKeyoptionalHTTP
oauth2optionalOAuth 2.0

Header parameters

Quire-Versionoptionalstring
The dated API revision to serve this request at. Omitted, the request is served at the revision the credential was issued against. The response echoes the revision actually applied.

format: date

Returns

200

Success.

JSON

policyobjectrequired
19 properties
- modeofforoptionalorrequiredorrequired_for_rolesrequired
- required_rolesarray ofstringrequired
- accepted_acr_valuesarray ofstringrequired
- cookie_cache_secondsnumberrequired
- password_min_lengthnumberrequired
- breach_check_enabledbooleanrequired
- magic_link_minutesnumberrequired
- self_registration_enabledbooleanrequired
- self_registration_domainsarray ofstringrequired
- self_registration_requires_approvalbooleanrequired
- enabled_methodsarray ofpasswordormagic_linkorpasskeyorsocialorssoorldaprequired
- mfa_methodsarray oftotporemail_otporbackup_coderequired
- password_require_mixed_casebooleanrequired
- password_require_digitbooleanrequired
- password_require_symbolbooleanrequired
- session_idle_minutesnumber | nullrequired
- session_absolute_hoursnumber | nullrequired
- max_concurrent_sessionsnumber | nullrequired
- guest_access_enabledbooleanrequired
connectionsarray ofobjectrequired
18 properties
- idstringrequired
  format: uuid, pattern: ^([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)$
- protocoloidcorsamlorldaporsocialrequired
- provider_keystringrequired
- display_namestringrequired
- issuerstringrequired
- client_idstring | nullrequired
- secret_configuredbooleanrequired
- domainsarray ofstringrequired
- settingsmap ofunknownrequired
- attribute_mappingmap ofunknownrequired
- role_mappingmap ofstringrequired
- accepted_acr_valuesarray ofstringrequired
- jit_provisioningbooleanrequired
- idp_initiatedbooleanrequired
- enabledbooleanrequired
- certificate_expires_atstringornullrequired
  2 variants
  One of the following:
  string
  null
- last_synced_atstringornullrequired
  2 variants
  One of the following:
  string
  null
- registrationmap ofstringrequired
rolesarray ofobjectrequired
2 properties
- short_namestringrequired
- namestringrequired

401

The credential is missing, malformed, expired or revoked.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

403

The credential lacks the scope this operation requires, or the acting subject lacks the capability.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

422

The request was understood and its content is not valid. errors names each field.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

429

A rate limit or a concurrency cap was reached. Retry-After says when to try again.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

500

Something failed at our end. Quote request_id when reporting it.

JSON

typestringrequired
format: uri
titlestringrequired
statusintegerrequired
codestringrequired
categoryvalidationorauthenticationorauthorizationornot_foundorconflictorprecondition+4 morerequired
detailstringrequired
request_idstringrequired
docs_urlstringrequired
format: uri
errorsoptionalarray ofobject
3 properties
- pathstringrequired
  RFC 6901 JSON Pointer into the request body.
- codestringrequired
- detailstringrequired
retry_afteroptionalinteger | null

{ "policy": { "mode": "off", "required_roles": [ "string" ], "accepted_acr_values": [ "string" ], "cookie_cache_seconds": 0, "password_min_length": 0, "breach_check_enabled": true, "magic_link_minutes": 0, "self_registration_enabled": true, "self_registration_domains": [ "string" ], "self_registration_requires_approval": true, "enabled_methods": [ "password" ], "mfa_methods": [ "totp" ], "password_require_mixed_case": true, "password_require_digit": true, "password_require_symbol": true, "session_idle_minutes": 0, "session_absolute_hours": 0, "max_concurrent_sessions": 0, "guest_access_enabled": true }, "connections": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "protocol": "oidc", "provider_key": "string", "display_name": "string", "issuer": "string", "client_id": "string", "secret_configured": true, "domains": [ "string" ], "settings": { "property1": null, "property2": null }, "attribute_mapping": { "property1": null, "property2": null }, "role_mapping": { "property1": "string", "property2": "string" }, "accepted_acr_values": [ "string" ], "jit_provisioning": true, "idp_initiated": true, "enabled": true, "certificate_expires_at": "2019-08-24T14:15:22Z", "last_synced_at": "2019-08-24T14:15:22Z", "registration": { "property1": "string", "property2": "string" } } ], "roles": [ { "short_name": "string", "name": "string" } ] }

{ "type": "http://example.com", "title": "string", "status": 0, "code": "string", "category": "validation", "detail": "string", "request_id": "string", "errors": [ { "path": "string", "code": "string", "detail": "string" } ], "retry_after": 0, "docs_url": "http://example.com" }