Added identity providers —
Check the API reference
LogoLogo
Other APIsChangelog
  • Welcome to Provisioning API
  • Getting started
    • API specification
    • Authorization
    • Applications
  • API reference
    • API credentials
      • The API credential object
      • Create an API credential
      • List all API credentials
      • Retrieve an API credential
      • Update an API credential
      • Delete an API credential
    • Application memberships
      • The application membership object
      • Create an application membership
      • List all application memberships
      • Retrieve an application membership
      • Update an application membership
      • Delete an application membership
    • Identity providers
      • The identity provider object
      • Create an identity provider
      • List all identity providers
      • Retrieve an identity provider
      • Update an identity provider
      • Delete an identity provider
    • Memberships
      • The membership object
      • Create a membership
      • List all memberships
      • Retrieve a membership
      • Update a membership
      • Delete a membership
    • Membership profiles
      • The membership profile object
      • Create a membership profile
      • List all membership profiles
      • Retrieve a membership profile
      • Update a membership profile
      • Delete a membership profile
    • Organizations
      • The organization object
      • Create an organization
      • List all organizations
      • Retrieve an organization
      • Update an organization
    • Permissions
      • The permission object
      • Create a permission
      • List all permissions
      • Retrieve a permission
      • Update a permission
    • Roles
      • The role object
      • Create a role
      • List all roles
      • Retrieve a role
      • Update a role
    • User
      • The user object
      • Retrieve the user
      • Update the user
    • Versions
      • The version object
      • List all versions
      • Retrieve a version
On this page
  1. API reference

Versions

The version object and the allowed CRUD operations on the related resource endpoint

PreviousUpdate the userNextThe version object

Last updated 6 days ago

Versions are associated with and are created upon every update or cancellation of the related resource to help you track the history of each resource's data changes.

are tracked also across creation. This is the only exception. For all other versionable resources creation is not tracked by the versions API.

Each version object contains information about the event that generated it (one of update or destroy — for roles, also create), the type of resource that has been modified, the request involved, the application, worker, or user that triggered the change, and more. You can find the changes history inside the changes object which shows, for each modified attribute, the values before and after the change. Changes to non-fetchable attributes (i.e. that are not exposed to the user in the single resource object) are tracked anyway by the versions API but you won't be able to see the modified values.

For any resource, the related changes history is stored for 1 year.

Versionable resources

At the moment, these are the resources that support versioning:

This is an immutable API, meaning that create, update, and delete operations are not allowed on this endpoint. You can only fetch a list of versions or a specific single one.

Roles
Memberships
Permissions
Roles
some of the Provisioning API resources