Skip to main content
POST
Add a SAML role mapping

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

Path Parameters

idp_id
string
required

Identity provider ID returned by the list operation.

Minimum string length: 1

Body

application/json
attributes
object
required

SAML attribute names and exact values that select this mapping.

is_account_admin
boolean
required

Whether matching users receive account administrator access.

organization
object | null

Organization role assignment, or null when no organization role is assigned.

space_roles
object[]

Space role assignments for matching users. An empty array grants no space roles. Non-empty assignments require organization.

project_roles
object[] | null

Project role assignments. Omit to use the default unmanaged state on create. Null leaves this mapping unmanaged. An empty array manages project roles with no assignments. Non-empty assignments require organization. If any mapping in this identity provider supplies an array (including an empty array), SAML replaces all project role bindings for users at login when sync_user_roles is enabled, using their matched mappings. This also replaces manually assigned project roles. Null leaves this mapping unmanaged; manual project roles are preserved only when every mapping is unmanaged.

Response

Successful response.

attributes
object
required

SAML attribute names and exact values that select this mapping.

is_account_admin
boolean
required

Whether matching users receive account administrator access.

space_roles
object[]
required

Space role assignments for matching users. An empty array grants no space roles.

project_roles
object[] | null
required

Configured project role assignments, or null when this mapping is unmanaged. If any mapping in this identity provider supplies an array (including an empty array), SAML replaces all project role bindings for users at login when sync_user_roles is enabled, using their matched mappings. This also replaces manually assigned project roles. Null leaves this mapping unmanaged; manual project roles are preserved only when every mapping is unmanaged.

id
string | null
required

Persistent server-generated mapping ID. File-managed mapping IDs identify the current file configuration. If a successful write returns null, read the configuration again before using the mapping ID.

organization
object | null

Organization role assignment, or null when no organization role is assigned.