Connections

Get connection by ID

Changed on

Returns the full details of a single connection

get/api/v3/connections/{connectionId}

Request

  • Base URL: https://fusion.adobe.io
  • URL: https://fusion.adobe.io/api/v3/connections/{connectionId}
  • Auth: HTTP bearer and API key in header x-organization-id and API key in header x-api-key and API key in header x-gw-region

Path parameters

connectionIdnumber required
Example:12345

Connection ID

Response

Returns the connection details

idnumber required

Unique connection ID.

namestring required

User-facing connection name.

accountNamestring required

Connector type identifier. Prefixed with app# for SDK-based connectors.

accountLabelstring required

Human-readable connector label in the requested language.

accountTypestring

Auth mechanism of the connector (e.g. oauth, basic).

expirestring date-time nullable

OAuth token expiry timestamp. null for non-OAuth auth types.

metadataobject nullable

Arbitrary connection metadata stored at authorisation time.

teamIdnumber required

ID of the team that owns this connection.

themestring required

Hex colour used to render the connector icon.

scopesCountnumber required

Number of OAuth scopes granted to this connection.

scopedboolean required

Whether the connection covers the requested OAuth scope set. Always true when no scope filter is applied.

editableboolean required

Whether the connector definition allows editing credentials.

uidstring nullable

Third-party user identifier captured at OAuth authorisation (e.g. Google account ID). null for non-OAuth connections.

environmentTypestring nullable

Deployment environment of the connected account (e.g. production, nonproduction).

authenticationTypestring nullable

Authentication sub-type (e.g. personalaccount, serviceaccount).

createdAtstring date-time required

Timestamp when the connection was first created.

typestring required

Connector type identifier (same value as accountName, without the app# prefix).

validboolean required

Whether the connection credentials are still valid (token not expired, not revoked).

defaultScopesstring[] required

Default scope set defined by the connector, normalised to an array.

Example response

{
  "id": 10752,
  "name": "My Workfront connection",
  "accountName": "adobe-workfront-oauth2",
  "accountLabel": "Adobe Workfront auth",
  "accountType": "oauth",
  "metadata": {
    "type": "text",
    "value": "John | my.workfront.com"
  },
  "teamId": 16496,
  "theme": "#db492b",
  "scopesCount": 3,
  "scoped": true,
  "environmentType": "nonproduction",
  "authenticationType": "personalaccount",
  "createdAt": "2024-03-15T10:22:00.000Z",
  "type": "adobe-workfront-promise",
  "valid": true,
  "defaultScopes": [
    "read:user"
  ],
  "scopes": [
    {
      "name": "The app can access the data user has given permission to, even when user is not using the app\"",
      "account": "workfront-workfront"
    }
  ]
}

Changes

  • 7c7767c7a45fRevision changes
    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed subschema #1 from the response property allOf list for the response status

    • info

      removed subschema #1 from the response property allOf list for the response status

    • info

      removed subschema #1 from the response property allOf list for the response status

    • info

      removed subschema #1 from the response property allOf list for the response status

    • info

      removed subschema #1 from the response property allOf list for the response status

  • 15ef44a12969Revision changes
    • info

      endpoint added