Managing Open API Credentials

Determine the Cluster Code from this page.

Creating credentials

When completed, this will DM (direct-message) you the credentials.

/tenant-openapi create CLUSTER TENANT-ID COMMENT

Example

/tenant-openapi create INDV account-3434-A "Internal development for finance integration"

Listing credentials

/tenant-openapi list CLUSTER

Example 

/tenant-openapi list INDV

The response will look like this:

Tenant.OpenApi - OpenAPI credentials in INDV cluster
-----------------------------------------------------------
TenantId = account-2652-A
ClientId = 1d3c55ra48kci6a161jq5g92og
ClientName = account-2652-A
WritePermissions = True
Comment = JIO PAC - internal development - created by RFS
-----------------------------------------------------------
TenantId = account-2717-A
ClientId = 1vj1nrci18f65gome3epgpgjhh
ClientName = HelpDocsLambda
WritePermissions = True
Comment =
-----------------------------------------------------------

Deleting credentials

Note that this requires a specific CLIENT-ID, not a TENANT-ID. This is because there may be multiple credentials per tenant.

/tenant-openapi delete CLUSTER CLIENT-ID

Example

/tenant-openapi delete INDV 1d4c51za43kti6a161jq5g72og

Retrieve a current secret 

This will DM (direct-message) you the ClientSecret(s) for the requested credential(s). You can use the CLIENT-ID or the TENANT-ID

/tenant-openapi secret CLUSTER [ CLIENT-ID | TENANT-ID ]

Examples

/tenant-openapi secret INDV 1d4c51za43kti6a161jq5g72og

/tenant-openapi secret INDV account-2717-A

Troubleshooting

If you do not receive a direct message while using create or secret, try sending a direct message to @ProServ.Automation and then running the command again.