Skip to main content
POST
Create a SAML identity provider

Authorizations

Authorization
string
header
required

Most Arize AI endpoints require authentication. For those endpoints that require authentication, include your API key in the request header using the format

Body

application/json

Supply exactly one metadata source: metadata_url or metadata_xml. Supplying both or neither returns 422.

email_domains
string[]
required

Unique email domains served by this identity provider.

Minimum array length: 1
Minimum string length: 1
enforce_saml
boolean
required

Whether users must authenticate through SAML.

sync_user_roles
boolean
required

Whether login applies role mappings to existing users.

sign_authn
boolean
required

Whether Arize signs SAML authentication requests sent to the identity provider.

allow_login_with_defaults
boolean
required

Whether users without a matching role mapping receive default roles.

metadata_url
string<uri>

HTTPS metadata URL. Supply this or metadata_xml.

Minimum string length: 1
metadata_xml
string

Metadata XML, at most 1 MiB. Supply this or metadata_url.

Required string length: 1 - 1048576
default_organization_id
string | null

Default organization ID, or null when default login is disabled.

default_space_id
string | null

Default space ID, or null when default login is disabled.

default_organization_role_id
string | null

Default organization role ID, or null when default login is disabled.

default_space_role_id
string | null

Default space role ID, or null when default login is disabled.

role_mappings
object[]

Role mappings for this identity provider.

Response

Successful response.

email_domains
string[]
required

Unique email domains served by this identity provider.

Minimum array length: 1
Minimum string length: 1
enforce_saml
boolean
required

Whether users must authenticate through SAML.

sync_user_roles
boolean
required

Whether login applies role mappings to existing users.

sign_authn
boolean
required

Whether Arize signs SAML authentication requests sent to the identity provider.

allow_login_with_defaults
boolean
required

Whether users without a matching role mapping receive default roles.

id
string
required

Identity provider ID.

Minimum string length: 1
is_managed_by_file
boolean
required

Whether configuration comes from a file. File configurations are read-only.

domain_verification
object[]
required

Current email domain verification state.

role_mappings
object[]
required

Role mappings for this identity provider.

metadata_url
string | null

Configured metadata URL, or null when XML is used.

metadata_xml
string | null

Configured metadata XML, or null when a URL is used.

default_organization_id
string | null

Default organization ID, or null when default login is disabled.

default_space_id
string | null

Default space ID, or null when default login is disabled.

default_organization_role_id
string | null

Default organization role ID, or null when default login is disabled.

default_space_role_id
string | null

Default space role ID, or null when default login is disabled.

created_at
string<date-time> | null

Creation time in UTC, or null for file-managed configuration.

updated_at
string<date-time> | null

Last update time in UTC, or null for file-managed configuration.