API Reference

Management API

The Synqly Management APIs enable you to manage the resources within your Synqly organization, such as setting up Accounts for your customers and creating Integrations to connect your product to the different service Providers supported by Synqly.

For more information see the Synqly Overview.

Download OpenAPI description

management.json

management.yaml

Servers

Synqly

https://api.synqly.com/

Accounts

Accounts under your Organization are used to manage Integrations, Credentials, and other account specific resources. Accounts are secure containers and may be used to represent tenants in your system. Data is never shared across accounts.

For more information on Accounts, see the Synqly Overview.

Operations

Audit

Operations

Auth

Operations

Logon

Request

Initiates a new session for the given member in a Synqly organization. The organization is identified by the given organization token.

Bodyapplication/jsonrequired

namestringrequired

Email address identifying the member to initiate a session for.

secretstringrequired

Password of the member to initiate a session for.

curl -i -X POST \
  https://api.synqly.com/v1/auth/logon \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "secret": "string"
  }'

Responses

Bodyapplication/json

resultobject(LogonResponseResult)required

result.auth_codestring(AuthCode)required

Enum"success""failure""disabled""expired""invited""locked"

result.refresh_token_idstring(Id)required

result.tokenobject(TokenPair)required

result.token.accessobject(Token)required

result.token.access.secretstringrequired

Secret value for the token; used for authentication when making requests.

result.token.access.expiresstring(date-time)required

Time when this token expires and can no longer be used again.

result.token.access.permissionsobject(Permission)required

result.token.access.permissions.resource_idstring(Id)required

result.token.access.permissions.resource_typestringrequired

Type of the resource that this permission grants access to. Must be one of the following: "organization, "integration"

result.token.access.permissions.parent_idstring(Id)required

result.token.access.permissions.idstring(Id)required

result.token.access.permissions.organization_idstring(Id)required

result.token.access.permissions.member_idstring(Id)required

result.token.access.permissions.role_bindingArray of strings or null(RoleName)

Roles granted to this token.

result.token.access.permissions.adhoc_roleobject(AdhocRole)

result.token.access.permissions.root_organization_idstring(Id)

result.token.refreshobject(Token)required

result.token.refresh.secretstringrequired

Secret value for the token; used for authentication when making requests.

result.token.refresh.expiresstring(date-time)required

Time when this token expires and can no longer be used again.

result.token.refresh.permissionsobject(Permission)required

result.token.refresh.permissions.resource_idstring(Id)required

result.token.refresh.permissions.resource_typestringrequired

Type of the resource that this permission grants access to. Must be one of the following: "organization, "integration"

result.token.refresh.permissions.parent_idstring(Id)required

result.token.refresh.permissions.idstring(Id)required

result.token.refresh.permissions.organization_idstring(Id)required

result.token.refresh.permissions.member_idstring(Id)required

result.token.refresh.permissions.role_bindingArray of strings or null(RoleName)

Roles granted to this token.

result.token.refresh.permissions.adhoc_roleobject(AdhocRole)

result.token.refresh.permissions.root_organization_idstring(Id)

result.organizationobject(Organization)required

result.organization.idstring(Id)required

result.organization.refresh_token_idstring(Id)required

result.organization.organization_typestring(OrganizationType)required

Enum"root""standard"

result.organization.fullnamestringrequired

Human friendly display name for this Organization

result.organization.namestringrequired

Human-readable name for this resource

result.organization.created_atstring(date-time)required

Time object was originally created

result.organization.updated_atstring(date-time)required

Last time object was updated

result.organization.contactstring or null

Organization email address

result.organization.reply_tostring or null

Reply-to email address, used for SMTP emails. Defaults to no-reply@synqly.com

result.organization.picturestring or null

Picture URL of the organization

result.organization.optionsobject(OrganizationOptions)

result.memberobject(Member)required

result.member.idstring(Id)required

result.member.statestring(State)required

Enum"disabled""enabled""forgotten""invited""locked"

result.member.last_logonstring(date-time)required

Last logon time

result.member.fullnamestringrequired

User's full display name.

result.member.ttlstringrequired

result.member.token_ttlstringrequired

result.member.expiresstring(date-time)required

result.member.pin_expiresstring(date-time)required

result.member.role_bindingArray of strings(RoleName)required

Roles granted to this member. Tokens inherit this access.

result.member.namestringrequired

Human-readable name for this resource

result.member.created_atstring(date-time)required

Time object was originally created

result.member.updated_atstring(date-time)required

Last time object was updated

result.member.nicknamestring or null

User's nickname

result.member.picturestring or null

Url of user's picture

result.auth_msgstring or null

Authentication failure message

Response

application/json

{
  "result": {
    "auth_code": "success",
    "auth_msg": "string",
    "refresh_token_id": "string",
    "token": { … },
    "organization": { … },
    "member": { … }
  }
}

Change Member Password

Request

Change member password.

Bodyapplication/jsonrequired

old_secretstringrequired

Old member secret

new_secretstringrequired

New member secret

curl -i -X POST \
  https://api.synqly.com/v1/auth/change_password \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "old_secret": "string",
    "new_secret": "string"
  }'

Responses

Bodyapplication/json

resultobject(ChangePasswordResponseResult)required

result.auth_codestring(AuthCode)required

Enum"success""failure""disabled""expired""invited""locked"

result.auth_msgstring or null

Authentication failure message

Response

application/json

{
  "result": {
    "auth_code": "success",
    "auth_msg": "string"
  }
}

Logoff

Request

Terminates the session identified by the given logon token.

curl -i -X POST \
  https://api.synqly.com/v1/auth/logoff \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Response

No content

Bridges

Operations

Capabilities

Operations

Credentials

Operations

Integration Points

An Integration Point describes a class of Integrations, and lets you describe names, allowed providers and other configuration that should apply to integrations associated with the Integration Point.

While an Integration can be created without associating it with an Integration Point, some Synqly features require the use of Integration Points, such as:

Connect UI
Validating allowed providers
Custom data mapping (coming soon)

Integration Points belong to the Organization, and can be associated with Integrations belonging to different Accounts.

For more information on Integration Points, see the Synqly Overview.

Operations

Integrations

An Integration represents the connection to a specific Provider. Once configured, an Integration enables interaction with the target Provider via our unified and normalized Connector APIs.

Each Integration belongs to an Account and may be associated with an Integration Point to provide additional features and configuration.

For more information on Integrations, see the Synqly Overview.

Operations

Members

Operations

Organization Webhooks

Operations

Organization

Operations

Permissionset

Operations

Roles

Operations

Status

Operations

Sub Orgs

Operations

Tokens

Operations

Transforms

Operations

Management API

Accounts

Audit

Auth

Logon

Request

Responses

Was this helpful?

Change Member Password

Request

Responses

Was this helpful?

Logoff

Request

Responses

Was this helpful?

Bridges

Capabilities

Credentials

Integration Points

Integrations

Members

Meta

Operations

Organization Webhooks

Organization

Permissionset

Roles

Status

Sub Orgs

Tokens

Transforms