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.