integrationInstanceIdstringrequired
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Integration Instance Auth Credentials
Represents the credentials use to authorize an integration instance.
You will want to configure the integration instance settings and authorization configuration before authorizing the instance.
This will inform the authorization process on how to reach and authorize the account.
Once the integration instance is authorized, the system will automatically discover all the relevant resources from the account.
The integration instance’s auth credentials can be removed or updated while retaining all resources which have already been discovered.
Create Integration Instance Auth Credential
Creates an auth credential scoped to the given integration instance.
Auth credentials are singleton resources that have a 1-to-1 relationship with
an integration instance.
An attempt to create subsequent auth credentials for an instance will result in a 409 response.
post
Path Parameters
Body
application/json
Body
application/json
CreateIntegrationInstanceAuthCredential
CreateIntegrationInstanceAuthCredential
One Oftypestringrequired
Allowed values:oauth
configobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
Response
application/json
Response
application/json
A response containing an integration instance auth credential.
IntegrationInstanceAuthCredential
IntegrationInstanceAuthCredential
Object containing metadata for an integration instance auth credential.
One Ofidstring(uuid)required
Example:4f535923-ec24-456c-b4e5-e67f65c8c208
integration_instanceobjectrequired
Short-hand descriptor of an integration instance.
Show Child Parameters
missing_permissionsarray[object]required
List of detected missing permissions required to enable the full functionality of the given integration instance.
Show Child Parameters
taintedbooleanrequired
Indicates that the credential is no longer valid and must be replaced with a new valid credential.
Example:false
expires_atstring | null(date-time)required
Timestamp denoting when the when the credential will expire in RFC-3339 format with a “T” character separating date from time within the field value.
When expired, the credential must be replaced with a new valid credential to re-enable full functionality for the given integration instance.
A null value indicates no known expiration time.
Example:2025-04-01T07:20:50Z
created_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
typestringrequired
Allowed values:oauth
post/integration-instances/{integrationInstanceId}/auth-credential
Authentication
Path Parameters
Body
{
"type": "multi_key_auth",
"config": {
"headers": [
{
"name": "authorization",
"key": "swaggerhub-api-key"
}
]
}
}
application/json
Get Integration Instance Auth Credential
Fetches the auth credential scoped to the given integration instance.
get
Path Parameters
integrationInstanceIdstringrequired
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Response
application/json
Response
application/json
A response containing an integration instance auth credential.
IntegrationInstanceAuthCredential
IntegrationInstanceAuthCredential
Object containing metadata for an integration instance auth credential.
One Ofidstring(uuid)required
Example:4f535923-ec24-456c-b4e5-e67f65c8c208
integration_instanceobjectrequired
Short-hand descriptor of an integration instance.
Show Child Parameters
missing_permissionsarray[object]required
List of detected missing permissions required to enable the full functionality of the given integration instance.
Show Child Parameters
taintedbooleanrequired
Indicates that the credential is no longer valid and must be replaced with a new valid credential.
Example:false
expires_atstring | null(date-time)required
Timestamp denoting when the when the credential will expire in RFC-3339 format with a “T” character separating date from time within the field value.
When expired, the credential must be replaced with a new valid credential to re-enable full functionality for the given integration instance.
A null value indicates no known expiration time.
Example:2025-04-01T07:20:50Z
created_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
typestringrequired
Allowed values:oauth
get/integration-instances/{integrationInstanceId}/auth-credential
Authentication
Path Parameters
application/json
Delete Integration Instance Auth Credential
Deletes the auth credential scoped to the given integration instance.
delete
Path Parameters
integrationInstanceIdstringrequired
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
Response
Response
Integration Instance Auth Credential was deleted successfully.
delete/integration-instances/{integrationInstanceId}/auth-credential
Authentication
Path Parameters
Integration Instance Auth Config
A integration instance may need to be provided with an auth config before authorizing the instance.
Typically an auth config will be required when authorizing against a integration which is hosted within your organization.
The integration instance’s auth config will inform how the Service Catalog will authorize the integration instance.
Note that updating the auth config for an instance which is already authorized will remove the existing credential, requiring you to re-authorize the instance.