Look up sign-in method for an organization

GET

/auth/auth_details

curl --request GET \
  --url 'https://api.retorio.com/be/v2/auth/auth_details?organizationName=customer'

Public, unauthenticated lookup used by a login page before the user has signed in: given an organization’s name, it says whether that organization signs in by SSO or by email and password, and returns the organization and company name and the logo to render on the sign-in screen, plus, for an SSO organization, the tenant id and (for a SAML or OIDC provider) the provider id the login page starts sign-in with. The organization’s privacy policy is not part of this response. This is a read of existing configuration. How single sign-on is set up: Single sign-on.

Authentication

Auth

None (public)

Parameters

Query Parameters

organizationName

required

string

>= 1 characters <= 255 characters

Example

customer

Responses

200

OK

Media typeapplication/json

object

organizationName

required

string

>= 1 characters <= 255 characters

organizationExtId

required

string

>= 1 characters <= 255 characters

companyName

required

string

>= 1 characters <= 255 characters

logoUrl

string

nullable >= 1 characters <= 255 characters

samlProviderId

string

nullable >= 1 characters <= 255 characters

tenantId

string

nullable >= 1 characters <= 255 characters

SSOType

required

Any of:

string

string

Allowed values: google microsoft saml oidc

string

string

Allowed values: email

Example

{
  "logoUrl": null,
  "samlProviderId": null,
  "tenantId": null,
  "SSOType": "google"
}

400

organizationName is missing or not valid.

Media typeapplication/json

object

message

required

string

status

required

Canonical error name, e.g. INVALID_ARGUMENT.

string

details

nullable

Example ^generated

{
  "message": "example",
  "status": "example",
  "details": "example"
}

404

No organization with this name.

Media typeapplication/json

object

message

required

string

status

required

Canonical error name, e.g. INVALID_ARGUMENT.

string

details

nullable

Example ^generated

{
  "message": "example",
  "status": "example",
  "details": "example"
}

500

Internal Server Error

Media typeapplication/json

object

key

additional properties

nullable

Example ^generated

{
  "additionalProperty": "example"
}