Get SAML configuration

Read the workspace's SAML 2.0 sign-in configuration and the service provider URLs to give your IdP.

GEThttps://api.tried.com.au/workspace/saml

Returns the workspace's SAML 2.0 configuration. When SAML is not set up yet, it still returns the service provider entity ID and ACS URL you need to register the app with your identity provider. Admin only.

Request#

This endpoint takes no path, query or body parameters.

Example request#

curl https://api.tried.com.au/workspace/saml \
  -H "Authorization: Bearer $TRIED_API_KEY"

const res = await fetch("https://api.tried.com.au/workspace/saml", {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const saml = await res.json();

import os, requests

res = requests.get(
    "https://api.tried.com.au/workspace/saml",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
saml = res.json()

Response#

200 OK

{
  "idp_sso_url": "https://harbourdental.okta.com/app/harbourdental_tried/exk1a2b3c4d5e6f7g8h9/sso/saml",
  "idp_entity_id": "http://www.okta.com/exk1a2b3c4d5e6f7g8h9",
  "has_idp_cert": true,
  "domains": [
    "harbourdental.com.au"
  ],
  "enabled": true,
  "default_role": "member",
  "mock": false,
  "sp_entity_id": "https://api.tried.com.au/auth/saml/ws_3f9a1c7e5b2d4086a1c9e7f2/metadata",
  "acs_url": "https://api.tried.com.au/auth/saml/ws_3f9a1c7e5b2d4086a1c9e7f2/acs",
  "metadata_url": "https://api.tried.com.au/auth/saml/ws_3f9a1c7e5b2d4086a1c9e7f2/metadata"
}

When SAML is not configured:

{
  "configured": false,
  "sp_entity_id": "https://api.tried.com.au/auth/saml/ws_3f9a1c7e5b2d4086a1c9e7f2/metadata",
  "acs_url": "https://api.tried.com.au/auth/saml/ws_3f9a1c7e5b2d4086a1c9e7f2/acs"
}

Field	Type	Description
`idp_sso_url`	string	Your identity provider's SAML single sign-on URL.
`idp_entity_id`	string	Your identity provider's entity ID (issuer).
`has_idp_cert`	boolean	Whether the IdP signing certificate is stored. The certificate is not returned.
`domains`	string[]	Email domains that sign in through SAML.
`enabled`	boolean	Whether SAML sign-in is on.
`default_role`	string	Role given to users who join through SAML: `admin`, `developer` or `member`.
`mock`	boolean	`true` when the built-in mock SAML identity provider is in use.
`sp_entity_id`	string	Tried's service provider entity ID for this workspace.
`acs_url`	string	Assertion consumer service URL to register with your IdP.
`metadata_url`	string	Service provider metadata XML. Same URL as `sp_entity_id`.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `admin` scope. A dashboard user without the right role gets `Requires role: admin`. API keys act as admin.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.