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
Languages
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

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

Meta

Operations

Operations (In Development)

In Development

This feature is actively being developed. Breaking changes should be expected.

Please contact us before using this feature.

Operations

Organization Webhooks

Operations

Organization

Operations

Permissionset

Operations

List PermissionSets

Request

Returns a list of all PermissionSets objects that match the query params.

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

Responses

Bodyapplication/json
resultArray of objects(PermissionSet)required
result[].​namestring(Permissions)required
Enum"administrator""viewer""member""account-manager""connect-ui""token-issuer"
result[].​permissionsobject(ApiPermissionMap)required
result[].​permissions.​allobject(ReadWritePermissions)

Permissions for all accounts

result[].​permissions.​accountsobject(AccountsPermissions)

Permissions for the accounts API

result[].​permissions.​alarmsobject(AlarmsPermissions)

Permissions for the alarms API

result[].​permissions.​alarm_policiesobject(AlarmPoliciesPermissions)

Permissions for the alarm policy API

result[].​permissions.​auditobject(AuditPermissions)

Permissions for the audit API

result[].​permissions.​authobject(AuthPermissions)

Permissions for the auth logon/logoff API

result[].​permissions.​bridgesobject(BridgesPermissions)

Permissions for the bridge API

result[].​permissions.​credentialsobject(CredentialsPermissions)

Permissions for the credentials API

result[].​permissions.​integrationsobject(IntegrationsPermissions)

Permissions for the integrations API

result[].​permissions.​integration_pointsobject(IntegrationPointsPermissions)

Permissions for the integrations points API

result[].​permissions.​operationsobject(OperationsPermissions)

Permissions for the operations API

result[].​permissions.​membersobject(MembersPermissions)

Permissions for the members API

result[].​permissions.​organizationsobject(OrganizationPermissions)

Permissions for the organization API

result[].​permissions.​permission_setobject(PermissionSetPermissions)

Permissions for the permissionset API

result[].​permissions.​rolesobject(RolesPermissions)

Permissions for the roles API

result[].​permissions.​statusobject(StatusPermissions)

Permissions for the status API

result[].​permissions.​suborgsobject(SubOrgsPermissions)

Permissions for the roles API

result[].​permissions.​tokensobject(TokensPermissions)

Permissions for the tokens API

result[].​permissions.​transformsobject(TransformsPermissions)

Permissions for the transforms API

result[].​permissions.​webhooksobject(WebhooksPermissions)

Permissions for the webhooks API

result[].​descriptionstring or null

Description of when the permission set should be used and what permissions are granted by the permission set.

result[].​resource_restrictionsArray of strings or null(ResourceRestrictions)

Resources that can be used with this permission set

Enum"accounts""integrations"
Response
application/json
{ "result": [ {} ] }

Get PermissionSet

Request

Returns the PermissionSet object matching {permissionsetId}. For more information on PermissionSets, refer to our Synqly Overview.

Path
permissionsetIdstring(Permissions)required
Enum"administrator""viewer""member""account-manager""connect-ui""token-issuer"
curl -i -X GET \
  'https://api.synqly.com/v1/permissionsets/{permissionsetId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
resultobject(PermissionSet)required
result.​namestring(Permissions)required
Enum"administrator""viewer""member""account-manager""connect-ui""token-issuer"
result.​permissionsobject(ApiPermissionMap)required
result.​permissions.​allobject(ReadWritePermissions)

Permissions for all accounts

result.​permissions.​accountsobject(AccountsPermissions)

Permissions for the accounts API

result.​permissions.​alarmsobject(AlarmsPermissions)

Permissions for the alarms API

result.​permissions.​alarm_policiesobject(AlarmPoliciesPermissions)

Permissions for the alarm policy API

result.​permissions.​auditobject(AuditPermissions)

Permissions for the audit API

result.​permissions.​authobject(AuthPermissions)

Permissions for the auth logon/logoff API

result.​permissions.​bridgesobject(BridgesPermissions)

Permissions for the bridge API

result.​permissions.​credentialsobject(CredentialsPermissions)

Permissions for the credentials API

result.​permissions.​integrationsobject(IntegrationsPermissions)

Permissions for the integrations API

result.​permissions.​integration_pointsobject(IntegrationPointsPermissions)

Permissions for the integrations points API

result.​permissions.​operationsobject(OperationsPermissions)

Permissions for the operations API

result.​permissions.​membersobject(MembersPermissions)

Permissions for the members API

result.​permissions.​organizationsobject(OrganizationPermissions)

Permissions for the organization API

result.​permissions.​permission_setobject(PermissionSetPermissions)

Permissions for the permissionset API

result.​permissions.​rolesobject(RolesPermissions)

Permissions for the roles API

result.​permissions.​statusobject(StatusPermissions)

Permissions for the status API

result.​permissions.​suborgsobject(SubOrgsPermissions)

Permissions for the roles API

result.​permissions.​tokensobject(TokensPermissions)

Permissions for the tokens API

result.​permissions.​transformsobject(TransformsPermissions)

Permissions for the transforms API

result.​permissions.​webhooksobject(WebhooksPermissions)

Permissions for the webhooks API

result.​descriptionstring or null

Description of when the permission set should be used and what permissions are granted by the permission set.

result.​resource_restrictionsArray of strings or null(ResourceRestrictions)

Resources that can be used with this permission set

Enum"accounts""integrations"
Response
application/json
{ "result": { "name": "administrator", "description": "string", "resource_restrictions": [], "permissions": {} } }

Roles

Operations

Status

Operations

Sub Orgs

Operations

Tokens

Operations

Transforms

Operations