Skip to main content
Create and manage organizations, spaces, memberships, API keys, SAML and gates. For task-oriented walkthroughs of these operations, see the Admin guide. Every mutation below is sent as a POST to https://app.arize.com/graphql with an x-api-key header; see Forming calls.

Mutations in this page

Reference

createOrganization

Create an organization to populate with spaces createOrganization(input: CreateOrganizationMutationInput!): CreateOrganizationMutationPayload

Arguments

CreateOrganizationMutationInput!
required

Returns

AccountOrganization!

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

createSpace

Create a space within an organization createSpace(input: CreateSpaceMutationInput!): CreateSpaceMutationPayload

Arguments

CreateSpaceMutationInput!
required

Returns

Space!

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

updateSpace

Update a space within an organization updateSpace(input: UpdateSpaceMutationInput!): UpdateSpaceMutationPayload

Arguments

UpdateSpaceMutationInput!
required

Returns

Space

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

deleteSpace

Delete a space deleteSpace(input: DeleteSpaceMutationInput!): DeleteSpaceMutationPayload

Arguments

DeleteSpaceMutationInput!
required

Returns

Boolean
Whether the space was deleted successfully

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

assignSpaceMembership

Assign multiple users to multiple spaces with appropriate roles assignSpaceMembership(input: AssignSpaceMembershipMutationInput!): AssignSpaceMembershipMutationPayload

Arguments

AssignSpaceMembershipMutationInput!
required

Returns

[SpaceMember!]

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

removeSpaceMember

Remove a user from a space removeSpaceMember(input: RemoveSpaceMemberMutationInput!): RemoveSpaceMemberMutationPayload

Arguments

RemoveSpaceMemberMutationInput!
required

Returns

Space

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

createUserApiKey

Create a new user API key createUserApiKey(input: CreateUserApiKeyInput!): CreateUserApiKeyPayload

Arguments

CreateUserApiKeyInput!
required

Returns

String
The newly created user API key
ApiKey
The information about the newly created API key

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

createServiceApiKey

Create a new service API key and its associated bot user createServiceApiKey(input: CreateServiceApiKeyInput!): CreateServiceApiKeyPayload

Arguments

CreateServiceApiKeyInput!
required

Returns

String
The ID of the newly created bot user
String
The newly created service API key
ApiKey
The information about the newly created service API key

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

revokeApiKey

Revokes an API key revokeApiKey(input: RevokeApiKeyInput!): RevokeApiKeyPayload

Arguments

RevokeApiKeyInput!
required

Returns

RevokeApiKeyStatus!
The status of the API key revocation One of: ok.

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

createSAMLIdP

Create a new SAML Identity Provider configuration createSAMLIdP(input: CreateSAMLIdPInput!): CreateSAMLIdPPayload

Arguments

CreateSAMLIdPInput!
required

Returns

SAMLIdP
The created SAML IdP configuration
String
Error message if the operation failed

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

updateSAMLIdP

Update an existing SAML Identity Provider configuration updateSAMLIdP(input: UpdateSAMLIdPInput!): UpdateSAMLIdPPayload

Arguments

UpdateSAMLIdPInput!
required

Returns

SAMLIdP
The updated SAML IdP configuration
String
Error message if the operation failed

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

addSAMLRoleMapping

Add a single role mapping to a SAML Identity Provider without touching its other role mappings. Rejected if a mapping with identical SAML attributes and organization already exists. addSAMLRoleMapping(input: AddSAMLRoleMappingInput!): AddSAMLRoleMappingPayload

Arguments

AddSAMLRoleMappingInput!
required

Returns

SAMLIdP
The updated SAML IdP configuration
String
Error message if the operation failed

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

createExporterAuditLog

Create an exporter audit log createExporterAuditLog(input: CreateExporterAuditLogInput!): CreateExporterAuditLogPayload

Arguments

CreateExporterAuditLogInput!
required

Returns

Boolean!
Whether or not the exporter audit log was successfully logged. False if logging is not enabled for the account.

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

setSpaceGateLimit

Set a rate limit gate value for a space. A value of 0 blocks all ingestion. setSpaceGateLimit(input: SetSpaceGateLimitMutationInput!): SetSpaceGateLimitMutationPayload

Arguments

SetSpaceGateLimitMutationInput!
required

Returns

Space

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

deleteSpaceGateLimit

Remove a rate limit gate from a space, resetting it to no limit. deleteSpaceGateLimit(input: DeleteSpaceGateLimitMutationInput!): DeleteSpaceGateLimitMutationPayload

Arguments

DeleteSpaceGateLimitMutationInput!
required

Returns

Space

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.