Description
Activate an LDAP/AD server connection profile in the Segura™ platform. An active server returns to the authentication chain and accepts configuration changes.
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-servers/{id}/activate
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
id |
integer | Yes | Unique identification code of the LDAP server. Note: this value is assigned by Segura™ in POST | Create LDAP server. |
The request takes no body.
Example request
POST {{url}}/api/v2/iam/ldap-servers/7/activate
Response
HTTP/1.1 204 No Content
The response has no body.
Info
After activation, GET | List an LDAP server by [id] returns active set to true, and meta.actions offers deactivate in place of activate.
Activating a server does not validate that the directory is reachable. To check the connection, access POST | Test LDAP server connection by [id].
Errors
| HTTP code | Message | Possible cause | Solution |
|---|---|---|---|
401 |
api.auth.unauthorized |
The access token is missing or has expired. | Request a new access token. |
404 |
api.resource.not_found |
The server does not exist. | Check the identification code sent in the path. |
409 |
api.resource.conflict.already_active |
The server is already active. | No action is needed. |
429 |
api.rate_limit.exceeded |
The request rate limit was exceeded. | Reduce the request rate and try again. |
Example error response
409 the server is already active:
{
"code": "api.resource.conflict.already_active",
"message": "LDAP server is already active.",
"details": null
}
For authentication error messages and the 403 versus 404 policy, access API v2 - Conventions and shared behaviors.