Constructor
new Organization(organizationID, config)
The constructor function is a special function that is called when an object is created from a class
| Name | Type | Description |
|---|---|---|
organizationID | string | The ID of the organization you want to get the list of users from. |
config | Config | This is the configuration object that is passed to the constructor of the base class. |
Extends
- SetConfig
Methods
createAPIKey(payload) → {Output-CreateAPIKey}
It creates an api key for the organization.
| Name | Type | Description |
|---|---|---|
payload | Input-CreateAPIKeyForOrg | Input-CreateAPIKeyForOrg |
The response from the API.
- Type:
- Output-CreateAPIKey
createApplication(payload) → {Output-CreateApplication}
It creates an application for the organization.
| Name | Type | Description |
|---|---|---|
payload | Input-CreateApplication | Input-CreateApplication |
The response from the API.
- Type:
- Output-CreateApplication
createGateway(payload) → {Output-CreateGateway}
It creates a gateway for the organization.
| Name | Type | Description |
|---|---|---|
payload | Input-CreateGateway |
The response from the API. ----> CreateGateway
- Type:
- Output-CreateGateway
getAPIKeyInfo(payload) → {Output-GetAPIKeyInfo}
It returns the information of the api key that has been created by the user.
| Name | Type | Description |
|---|---|---|
payload | Input-GetAPIKeyInfo | Input-GetAPIKeyInfo |
The response from the API.
- Type:
- Output-GetAPIKeyInfo
getAPIKeyList(payloadopt) → {Output-GetAPIKeyList}
It returns the list of api keys that have been created by the organization.
| Name | Type | Attributes | Description |
|---|---|---|---|
payload | Input-GetAPIKeyList | <optional> | Input-GetAPIKeyList |
The response from the API.
- Type:
- Output-GetAPIKeyList
getApplicationList(payloadopt) → {Output-GetApplicationList}
It returns the list of applications that have been created by the organization.
| Name | Type | Attributes | Description |
|---|---|---|---|
payload | Input-GetApplicationList | <optional> | Input-GetApplicationList |
The response from the API.
getCollaboratorInfo(payload) → {Output-GetCollaboratorInfo}
It returns rights of the collaborator (member) of the application.
| Name | Type | Description |
|---|---|---|
payload | Input-GetCollaboratorInfo | Input-GetCollaboratorInfo |
The response from the API.
getGatewayList(payloadopt) → {Output-GetGatewayList}
It returns the list of gateways that have been created by the organization.
| Name | Type | Attributes | Description |
|---|---|---|---|
payload | Input-GetGatewayList | <optional> | Input-GetGatewayList |
The response from the API. ----> GetGatewayList
- Type:
- Output-GetGatewayList
setCollaborator(payload) → {Output-EmptyPayload}
It sets the rights of a collaborator (member) on the application.
| Name | Type | Description |
|---|---|---|
payload | Input-SetCollaborator | Input-SetCollaborator |
The response from the API.
- Type:
- Output-EmptyPayload
updateAPIKey(payload) → {Output-UpdateAPIKey}
It returns the information of the api key that has been created by the user.
| Name | Type | Description |
|---|---|---|
payload | Input-UpdateAPIKeyOfOrg | Input-UpdateAPIKeyOfOrg |
The response from the API.
- Type:
- Output-UpdateAPIKey