Description
Deactivate an active LDAP group synchronization in the Segura™ platform. The active state is read-only in the resource body, so this action is the only way to clear it. To start a synchronization again, access POST | Activate LDAP group sync.
Prerequisites
- An application with the Users authorization granted by the administrator in A2A, and its resource permission set to Read and write. For more information, access How to manage authorizations in A2A.
- A valid OAuth 2.0 access token. For more information, access How to authenticate an application in A2A.
Request
POST /api/v2/iam/ldap-group-syncs/[id]/deactivate
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
id |
int | Yes | Unique identification code of the synchronization. |
Headers
| Header | Required | Description |
|---|---|---|
Content-Type |
Yes | Must be application/json, even though the request carries no body. |
Attention
Send the Content-Type header with an empty body. Omitting it returns an error.
Example request POST {{url}}/api/v2/iam/ldap-group-syncs/501/deactivate
Response
HTTP/1.1 204 No Content
The response carries no body. Read the synchronization with GET | List an LDAP group sync by [id] to confirm the new state and collect the updated ETag.
Info
Deactivating a synchronization stops it from running. It does not revoke the accesses granted by earlier runs. Running an inactive synchronization returns 409 api.resource.inactive.
Errors
| HTTP code | Message | Possible cause | Solution |
|---|---|---|---|
403 |
api.permission.denied |
The application lacks permission for this resource. | Ask the administrator to check the application's Users authorization in A2A. |
404 |
api.resource.not_found |
No synchronization exists with the identification code sent. | Check the id and resend the request. |
409 |
api.resource.conflict.already_inactive |
The synchronization is already inactive. | No action is needed. Read the resource to confirm its state. |
429 |
rate_limit_exceeded |
The application exceeded its request quota. | Wait for the period in the Retry-After header and resend the request. |
Authentication errors
| Message | Possible cause | Solution |
|---|---|---|
Client authentication failed. |
Application authentication failure with the Segura server. | Check the authentication parameters (Access Token URL, Client ID, and Client secret) and request a new access token. |
Invalid signature |
Failure in recognizing the client application URL. | Check the URL of the client application and resend the request. |
No route matched with those values. |
Missing authorization header in the API request. | Request a new access token. |
Request timed out. |
The request exceeded the timeout limit. | Check the connectivity between the source of the request and the Segura server. |