SaaS Accounts
Contents
SaaS Accounts
A SaaS account stores the credentials needed to access a SaaS provider. It allows the user to access the services of a SaaS provider through the platform.
List SaaS Accounts
GET /v3/settings/saas_accounts
It lists the SaaS accounts of the customer.
Inputs
None
Returns
An array of SaaS accounts of the following format:
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the SaaS account. |
| saas_provider_id | String | Identifier of the SaaS provider. |
| resource_type | String | An identifier for the type of resource, specifically "saas_account". |
Create SaaS Account
POST /v3/settings/saas_accounts
Creates a new SaaS account.
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| saas_provider_id | String | Identifier of the SaaS provider. | Yes |
| account_data | JSON object | A mapping assigning a value to each of the required account data of the SaaS provider. | Yes |
Returns
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the SaaS account. |
| saas_provider_id | String | Identifier of the SaaS provider. |
| resource_type | String | An identifier for the type of resource, specifically "saas_account". |
Update SaaS Account
PUT /v3/settings/saas_accounts/:id
Updates an existing SaaS account
Inputs
| Field | Type | Description | Required |
|---|---|---|---|
| account_data | JSON object | A mapping assigning a value to each of the required account data of the SaaS provider. | No |
Returns
| Field | Type | Description |
|---|---|---|
| id | String | Identifier of the SaaS account. |
| saas_provider_id | String | Identifier of the SaaS provider. |
| resource_type | String | An identifier for the type of resource, specifically "saas_account". |
Delete SaaS Account
DELETE /v3/settings/saas_accounts/:id
It deletes a SaaS account.
Inputs
None
Returns
None