Organization API: Customer Portal: Credentials
The 5 Organization API operations for credentials.
Part of Customer Portal.
GET /api/v1/orgs/{org_slug}/portal/mail/{service_id}/credentials
| Name |
In |
Type |
Required |
org_slug |
path |
string |
yes |
service_id |
path |
integer |
yes |
| Status |
Meaning |
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
POST /api/v1/orgs/{org_slug}/portal/mail/{service_id}/credentials
| Name |
In |
Type |
Required |
org_slug |
path |
string |
yes |
service_id |
path |
integer |
yes |
application/json (required)
| Field |
Type |
Required |
domain_id |
integer |
yes |
label |
string |
no |
| Status |
Meaning |
201 |
Success. |
422 |
The request is not valid. detail lists each problem. |
DELETE /api/v1/orgs/{org_slug}/portal/mail/{service_id}/credentials/{account_id}
| Name |
In |
Type |
Required |
account_id |
path |
integer |
yes |
org_slug |
path |
string |
yes |
service_id |
path |
integer |
yes |
| Status |
Meaning |
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
PATCH /api/v1/orgs/{org_slug}/portal/mail/{service_id}/credentials/{account_id}/enabled
| Name |
In |
Type |
Required |
account_id |
path |
integer |
yes |
org_slug |
path |
string |
yes |
service_id |
path |
integer |
yes |
application/json (required)
| Field |
Type |
Required |
enabled |
boolean |
yes |
| Status |
Meaning |
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
POST /api/v1/orgs/{org_slug}/portal/mail/{service_id}/credentials/{account_id}/rotate
| Name |
In |
Type |
Required |
account_id |
path |
integer |
yes |
org_slug |
path |
string |
yes |
service_id |
path |
integer |
yes |
| Status |
Meaning |
200 |
Success. |
422 |
The request is not valid. detail lists each problem. |
