{
"id": "4fb901ac-5281-4bfb-99f5-848c4d66a95c",
"attributes": {
"groups": "admins"
},
"is_account_admin": true,
"organization": null,
"space_roles": [],
"project_roles": null
}{
"status": 401,
"title": "Authentication required",
"detail": "You must be authenticated to access this resource.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#authentication-required"
}{
"status": 403,
"title": "Access forbidden",
"detail": "You do not have permission to access this resource.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#access-forbidden"
}{
"status": 404,
"title": "Resource not found",
"detail": "The requested resource with ID '12345' was not found.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#resource-not-found"
}{
"status": 409,
"title": "Resource conflict",
"detail": "A resource with the given identifier already exists.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#resource-conflict"
}{
"status": 422,
"title": "Unprocessable Entity",
"detail": "One or more fields failed validation.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity"
}{
"status": 429,
"title": "Rate limit exceeded",
"detail": "You have exceeded the allowed number of requests. Please try again later.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded"
}Update supplied mapping fields
Warning: This API is alpha and can change without notice. Requires Enterprise account-admin access. Mapping changes are atomic and preserve required login and admin mappings. File-managed configurations are read-only. For custom space roles and project roles, the first matching rule for each resource wins in configuration order. Built-in space roles use the most permissive matching built-in role. Updating a mapping preserves its position. For existing users, changes to stored role assignments apply at their next successful SAML login only when sync_user_roles is true. Mapping changes do not revoke current sessions or API keys.
{
"id": "4fb901ac-5281-4bfb-99f5-848c4d66a95c",
"attributes": {
"groups": "admins"
},
"is_account_admin": true,
"organization": null,
"space_roles": [],
"project_roles": null
}{
"status": 401,
"title": "Authentication required",
"detail": "You must be authenticated to access this resource.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#authentication-required"
}{
"status": 403,
"title": "Access forbidden",
"detail": "You do not have permission to access this resource.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#access-forbidden"
}{
"status": 404,
"title": "Resource not found",
"detail": "The requested resource with ID '12345' was not found.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#resource-not-found"
}{
"status": 409,
"title": "Resource conflict",
"detail": "A resource with the given identifier already exists.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#resource-conflict"
}{
"status": 422,
"title": "Unprocessable Entity",
"detail": "One or more fields failed validation.",
"instance": "/resource/12345",
"type": "https://arize.com/docs/ax/rest-reference/errors#unprocessable-entity"
}{
"status": 429,
"title": "Rate limit exceeded",
"detail": "You have exceeded the allowed number of requests. Please try again later.",
"instance": "/resource",
"type": "https://arize.com/docs/ax/rest-reference/errors#rate-limit-exceeded"
}Authorizations
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
Identity provider ID returned by the list operation.
1Mapping ID returned by list or add.
1Body
Omitted fields remain unchanged. Attributes and assignment lists replace their complete values. Empty lists clear assignments. organization:null clears the organization only if the resulting mapping remains valid. project_roles:null leaves this mapping unmanaged; manual project roles are preserved only when every mapping is unmanaged.
SAML attribute names and exact values that select this mapping.
Show child attributes
Show child attributes
Whether matching users receive account administrator access.
Organization role assignment, or null when no organization role is assigned.
Show child attributes
Show child attributes
Space role assignments for matching users. An empty array grants no space roles.
Show child attributes
Show child attributes
Omit to leave this mapping unchanged. An array manages project roles; an empty array clears this mapping's project assignments. Null leaves this mapping unmanaged. With role sync enabled, any managed mapping enables project-role synchronization for the identity provider. Login replaces project roles using matched mappings, including removal of manual grants. Manual project roles are preserved only when every mapping is unmanaged.
Show child attributes
Show child attributes
Response
Successful response.
SAML attribute names and exact values that select this mapping.
Show child attributes
Show child attributes
Whether matching users receive account administrator access.
Space role assignments for matching users. An empty array grants no space roles.
Show child attributes
Show child attributes
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.
Show child attributes
Show child attributes
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 role assignment, or null when no organization role is assigned.
Show child attributes
Show child attributes
Was this page helpful?