API Categories

The API is separated into major categories. Each category covers one or more resources and the resources’ methods.

CategorySummary
AccountsMethods to get Account information
BulkOperationsMethods to import and export users and accounts.
IdentityProvidersMethods to get a list of identity providers.
ReservedDomainsMethods to get a list of reserved domains.
UsersMethods to manage users in an account.

API Method list

ResourceMethodHTTP MethodEndpoint
AccountExportcreateAccountSettingsExportPOST/v2/organizations/{organizationId}/exports/account_settings
AccountExportdeleteAccountSettingsExportDELETE/v2/organizations/{organizationId}/exports/account_settings/{exportId}
AccountExportgetAccountSettingsExportGET/v2/organizations/{organizationId}/exports/account_settings/{exportId}
AccountExportgetAccountSettingsExportsGET/v2/organizations/{organizationId}/exports/account_settings
AccountsgetGroupsGET/v2/organizations/{organizationId}/accounts/{accountId}/groups
AccountsgetOrganizationsGET/v2/organizations
AccountsgetPermissionsGET/v2/organizations/{organizationId}/accounts/{accountId}/permissions
IdentityProvidersgetIdentityProvidersGET/v2/organizations/{organizationId}/identity_providers
ReservedDomainsgetReservedDomainsGET/v2/organizations/{organizationId}/reserved_domains
UserExportcreateUserListExportPOST/v2/organizations/{organizationId}/exports/user_list
UserExportdeleteUserListExportDELETE/v2/organizations/{organizationId}/exports/user_list/{exportId}
UserExportgetUserListExportGET/v2/organizations/{organizationId}/exports/user_list/{exportId}
UserExportgetUserListExportsGET/v2/organizations/{organizationId}/exports/user_list
UserImportaddBulkUserImportPOST/v2/organizations/{organizationId}/imports/bulk_users/add
UserImportcloseBulkUserImportRequestPOST/v2/organizations/{organizationId}/imports/bulk_users/close
UserImportdeleteBulkUserImportDELETE/v2/organizations/{organizationId}/imports/bulk_users/{importId}
UserImportgetBulkUserImportCSVGET/v2/organizations/{organizationId}/imports/bulk_users/{importId}/results_csv
UserImportgetBulkUserImportRequestGET/v2/organizations/{organizationId}/imports/bulk_users/{importId}
UserImportgetBulkUserImportRequestsGET/v2/organizations/{organizationId}/imports/bulk_users
UserImportupdateBulkUserImportsPOST/v2/organizations/{organizationId}/imports/bulk_users/update
UsersactivateMembershipPOST/v2/organizations/{organizationId}/users/{userId}/memberships/{membershipId}
UsersaddUsersPOST/v2/organizations/{organizationId}/accounts/{accountId}/users
UserscloseMembershipsDELETE/v2/organizations/{organizationId}/users/{userId}/accounts
UserscreateUserPOST/v2/organizations/{organizationId}/users
UsersdeleteIdentitiesDELETE/v2/organizations/{organizationId}/users/{userId}/identities
UsersgetUserProfilesGET/v2/organizations/{organizationId}/users/profile
UsersgetUsersGET/v2/organizations/{organizationId}/users
UsersupdateEmailAddressPOST/v2/organizations/{organizationId}/users/email_addresses
UsersupdateUserPOST/v2/organizations/{organizationId}/users/profiles
}} />