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
  2. API credentials

The API credential object

A comprehensive list of the API credential resource's attributes and relationships

An API credential object is returned as part of the response body of each successful create, list, retrieve or update API call to the /api/api_credentials endpoint.

Fields

Field
Type
Description

type

string

api_credentials

id

string

The API credential unique identifier.

links.self

string

The API credential endpoint URL.

attributes.name

string

The API credential internal name.

attributes.kind

string

The API credential kind, can be one of: webapp, sales_channel, integration or the kind of app you want to fork (e.g. orders, imports, etc.).

attributes.confidential

boolean

Indicates if the API credential it's confidential.

attributes.redirect_uri

string

The API credential redirect URI.

attributes.client_id

string

The API credential unique ID.

attributes.client_secret

string

The API credential unique secret.

attributes.scopes

string

The API credential scopes.

attributes.expires_in

integer

The lifetime of the access token in seconds (min. 7200, max. 31536000. Default is 14400 for Sales channels and 7200 for other client types).

attributes.mode

string

Indicates the environment the resource belongs to (one of test or live).

attributes.custom

boolean

Indicates if the API credential is used to create a custom app (e.g. fork a hosted app).

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

Time at which the resource was last updated.

attributes.reference

string

A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.

attributes.reference_origin

string

Any identifier of the third party system that defines the reference code.

attributes.metadata

object

Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.

relationships.organization

object

The organization associated to the API credential.

relationships.role

object

The role associated to the API credential.

PreviousAPI credentialsNextCreate an API credential

Last updated 5 months ago