Suspension Status¶

The Suspension status feature is based on the usage of the provisioning templates of category group_intercept with default_values mechanism (for further information, see Create Provisioning Template).

The default values definition come from the Group Intercept Update configuration API.

The PUT API will configure that Group Intercept feature of the Group with these values.

It must be noted that as the Suspension status is based on template name, its name is stored in the APIO DB (Group Data object), not in the AS.

Configuration Information for Group Suspension Status¶

The suspension status feature is based on the usage of the provisioning templates of category group_intercept with default_values mechanism (for further informations, see Create Provisioning Template).

The default values come from the Group Intercept Update configuration API.

The APIO behaviour is controlled by the following settings:

"SUSPENSION_STATUS": {
   "ENABLED": true,
   "ALLOW_DIFFERENT_FOR_GROUP": false
}

Display tenant’s suspension status¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/properties/suspension/¶

Retrieve the settings of the Suspension Status of a Group.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/properties/suspension/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
   "suspensionStatus": "bad_payer"
}

Response JSON Object:

suspensionStatus (string) – the name of the suspension status to be set. Empty string for not suspended status.

Status Codes:

200 OK – no error
404 Not Found – the suspension status feature is not enabled by setting

Update a tenant’s suspension status¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/properties/suspension/¶

Update the settings of the Suspension Status of a Group.

The suspension status can be applied if:

allowed by setting (see Configuration Information for Group Suspension Status),
it’s the same as the Tenant or the Tenant does not have one or a different is allowed in the settings.

Authorization rights: minimum System Admin.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/properties/suspension/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
   "suspensionStatus": "bad_payer"
}

Request JSON Object:

suspensionStatus (string) – the name of the suspension status to be set. Empty string for not suspended status.

Example response:

Response:

Similar to GET instance method response.

Status Codes:

200 OK – no errors
400 Bad Request – the suspension status cannot be applied because not allowed by setting
404 Not Found – the suspension status template does not exist or the feature is not enabled by setting