idstringrequired
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Get Integration Instance Auth Config
Fetches auth config scoped to the given integration instance.
get
Path Parameters
Response
200 application/json
Response
200 application/json
A response containing integration instance auth config.
IntegrationInstanceAuthConfig
IntegrationInstanceAuthConfig
One Oftypestringrequired
Allowed values:oauth
client_idstringrequired
The OAuth client identifier.
Example:d745213a-b7e8-4998-abe3-41f164001970
authorization_endpointstring(uri)required
The URL where users are redirected to authorize access.
Example:https://identity.service.com/oauth/authorize
token_endpointstring(uri)required
The URL used to retrieve access tokens.
Example:https://identity.service.com/oauth/token
get/integration-instances/{id}/auth-config
Path Parameters
200 application/json
Upsert Integration Instance Auth Config
Upserts auth config scoped to the given integration instance.
put
Path Parameters
idstringrequired
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Body
application/json
Body
application/json
UpsertIntegrationInstanceAuthConfig
UpsertIntegrationInstanceAuthConfig
One Oftypestringrequired
Allowed values:oauth
client_idstringrequired
The OAuth client identifier.
Example:d745213a-b7e8-4998-abe3-41f164001970
client_secretstringrequired
The OAuth client secret.
Example:s3cr3t4p1cl13ntt0k3n1234567890abcdef
authorization_endpointstring(uri)required
The URL where users are redirected to authorize access.
Example:https://identity.service.com/oauth/authorize
token_endpointstring(uri)required
The URL used to retrieve access tokens.
Example:https://identity.service.com/oauth/token
Response
200 application/json
Response
200 application/json
A response containing integration instance auth config.
IntegrationInstanceAuthConfig
IntegrationInstanceAuthConfig
One Oftypestringrequired
Allowed values:oauth
client_idstringrequired
The OAuth client identifier.
Example:d745213a-b7e8-4998-abe3-41f164001970
authorization_endpointstring(uri)required
The URL where users are redirected to authorize access.
Example:https://identity.service.com/oauth/authorize
token_endpointstring(uri)required
The URL used to retrieve access tokens.
Example:https://identity.service.com/oauth/token
put/integration-instances/{id}/auth-config
Path Parameters
Body
{}
200 application/json
Delete Integration Instance Auth Config
Deletes the auth config scoped to the given integration instance.
delete
Path Parameters
idstringrequired
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Response
204
Response
204
Integration Instance Auth Config was deleted successfully.
delete/integration-instances/{id}/auth-config
Path Parameters
204
Resources
List Resources
Returns a paginated collection of resources.
get
Query Parameters
filterobject
Filters a collection of resources.
sort
Sorts a collection of resources. Supported sort attributes are:
created_atupdated_at
Default sort is created_at in descending order.
Response
200 application/json
Response
200 application/json
A paginated list response for a collection of resources.
* Additional properties are NOT allowed.
metarequired
dataarray[object]required
Information about a catalog resource.
Show Child Parameters
get/resources
Query Parameters
200 application/json