Properties
Private rest
rest: Promise<Got>
Private userAgentString
userAgentString: string
Methods
createClient
- createClient(req): Promise<CreatedClusterClient>
Parameters
- req: {
clientName: string;
clusterUuid: string;
permissions: string[];
}clientName: string
clusterUuid: string
permissions: string[]
createCluster
- createCluster(createClusterRequest): Promise<{
clusterId: string;
}> Returns Promise<{
clusterId: string;
}>
createMember
- createMember(email, orgRoles): Promise<null>
Returns Promise<null>
createSecret
- createSecret(__namedParameters): Promise<null>
Parameters
- __namedParameters: {
clusterUuid: string;
secretName: string;
secretValue: string;
}clusterUuid: string
secretName: string
secretValue: string
Returns Promise<null>
deleteClient
- deleteClient(clusterUuid, clientId): Promise<null>
Parameters
- clusterUuid: string
- clientId: string
Returns Promise<null>
deleteCluster
- deleteCluster(clusterUuid): Promise<null>
Returns Promise<null>
deleteMember
- deleteMember(email): Promise<null>
Returns Promise<null>
deleteSecret
- deleteSecret(clusterUuid, secretName): Promise<null>
Parameters
- clusterUuid: string
- secretName: string
Returns Promise<null>
Private getHeaders
- getHeaders(): Promise<{
accept: string;
authorization: string;
content-type: string;
user-agent: string;
}> Returns Promise<{
accept: string;
authorization: string;
content-type: string;
user-agent: string;
}>
getSecrets
- getSecrets(clusterUuid): Promise<{
[key: string]: string;
}> Returns Promise<{
[key: string]: string;
}>
whitelistIPs
- whitelistIPs(clusterUuid, ipwhitelist): Promise<null>
Parameters
- clusterUuid: string
- ipwhitelist: [{
description: string;
ip: string;
}]
Returns Promise<null>
This class provides methods to interact with the Camunda Admin API.
Throws
An error that may occur during API operations.