integrationInstanceIdstringrequired
The id of the integration instance.
Example:3f51fa25-310a-421d-bd1a-007f859021a3
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.
Get Integration Instance Auth Config
Fetches auth config scoped to the given integration instance.
get
Path Parameters
Response
application/json
Response
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/{integrationInstanceId}/auth-config
Authentication
Path Parameters
application/json
Upsert Integration Instance Auth Config
Upserts auth config scoped to the given integration instance.
put
Path Parameters
integrationInstanceIdstringrequired
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
application/json
Response
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/{integrationInstanceId}/auth-config
Authentication
Path Parameters
Body
{
"type": "oauth",
"client_id": "767b05381bc6a4bbffb4473e06bec7ecf009d0c16afb7214acda33026b6af089",
"client_secret": "gloas-0bf0372129935e5f7cecbaba259336617c8fe9243f3adb0d6562775ebac21086",
"authorization_endpoint": "http://gitlab.my-company.com/oauth/authorize",
"token_endpoint": "http://gitlab.my-company.com/oauth/token"
}
application/json
Delete Integration Instance Auth Config
Deletes the auth config 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 Config was deleted successfully.
delete/integration-instances/{integrationInstanceId}/auth-config
Authentication
Path Parameters
Catalog Resources
Resources are entities discovered from integration instances and are intended to be mapped to the relevant services in the catalog.
Once a resource has been mapped to a service, a rich view of this resource will be displayed when viewing your service.
Any resources which you would like to ignore and hide can be archived.
Note that archiving a resource will remove any mappings it has to services in the catalog.
You can create Resources using only the properties required to identify the resource in the third-party system.
Additional data will be hydrated if the integration that the Resource is linked to has been provided with authentication credentials.
Resources which have not yet been hydrated may still be mapped to a Catalog Service.