LdapAuthorityResource

LdapAuthorityResource REST endpoint for ACP LDAP authorities Copyright 2014 WANdisco.

The following resources are part of this group:

/ldapauthorities

Mount Point: /ldapauthorities

POST

Create an LDAP authority

Parameters

name description type default
force (no documentation provided) query false

Request Body

element: ldapauthority
media types: */*
application/xml

LdapAuthorityDTO representation of the authority

Response Body

element: (custom)
media types: */*
application/xml

ID of the task monitoring the proposal

Status Codes

code description
202 Accepted - proposed
400 Bad request - see returned ExceptionDTO
503 Service unavailable - see returned ExceptionDTO
401 Authentication required.
403 Authorization required - access forbidden

GET

Retrieve paged list of access control objects

Parameters

name description type default
queryEnforced "true" to query the current/enforced model, i.e. the model as it was the last time files where generated, "false" to query the pending/shadow model, i.e. the model as it will be when pending batch updates are eventually applied at some point in the future. Note that this query param is only applicable/relevant for when batched updates is enabled, if batch updates is disabled, this query param is ignored. query false
pageSize number of entries per page query 20
pageNumber page to return query 1
fieldList list of fields to be populated in returned DTOs query
sortAscending "true" if results should be sorted ascending query true
sortColumn column name to perform sort by query id
searchKeyList list of keys to search by query
searchValueList list of values to search for query

Response Body

element: pagedresultlist
media types: application/xml
application/json

a PagedResultListDTO of returned DTOs

Status Codes

code description
200 OK
400 Bad request - see returned ExceptionDTO
503 Service unavailable - see returned ExceptionDTO
401 Authentication required.
403 Authorization required - access forbidden

/ldapauthorities/generateLdapTeamReport

Mount Point: /ldapauthorities/generateLdapTeamReport

POST

Generate report indicating what affect the new dto will have on the tea

Request Body

element: ldapauthority
media types: */*
application/xml

(no documentation provided)

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

Status Codes

code description
200 OK
401 Authentication required.
403 Authorization required - access forbidden

/ldapauthorities/search

Mount Point: /ldapauthorities/search

GET

Searches all ldap authorities for a given user

Parameters

name description type default
accountName Name of user to search for query
authorityList List of authorities to search on, a null list searches all of them query

Response Body

element: (custom)
media types: application/xml
application/json

List of users who match searched for term

Status Codes

code description
200 OK
400 Bad request - see returned ExceptionDTO
503 Service unavailable - see returned ExceptionDTO
401 Authentication required.
403 Authorization required - access forbidden

/ldapauthorities/testConnection

Mount Point: /ldapauthorities/testConnection

POST

Perform a test connection to the specified LDAP authority

Parameters

name description type default
pageSize number of results to return query 20
filter optional query filter query

Request Body

element: ldapauthority
media types: */*
application/xml

LdapAuthorityDTO representation of the target authority

Response Body

element: testConnectionResult
media types: */*
application/xml

TestConnectionResultDTO of results

Status Codes

code description
200 OK
400 Bad request - see returned ExceptionDTO
503 Service unavailable - see returned ExceptionDTO
401 Authentication required.
403 Authorization required - access forbidden

/ldapauthorities/{id}

Mount Point: /ldapauthorities/{id}

The following operations are supported on this resource:

PUT

Edit an LDAP Authority

Parameters

name description type default
id ID of the target LDAP authority path
force (no documentation provided) query false

Request Body

element: ldapauthority
media types: */*
application/xml

LdapAuthorityDTO representation of the updated authority

Response Body

element: (custom)
media types: */*
application/xml

ID of the task monitoring the proposal

Status Codes

code description
202 Accepted - proposed
404 Not found - see returned ExceptionDTO
400 Bad request - see returned ExceptionDTO
503 Service unavailable - see returned ExceptionDTO
401 Authentication required.
403 Authorization required - access forbidden

DELETE

Deletes an access control object

Parameters

name description type default
id ID of the model object to delete path

Response Body

element: (custom)
media types: */*
application/xml

ID of the task monitoring the deletion

Status Codes

code description
202 Accepted - proposed
404 Not found - see returned ExceptionDTO
400 Bad request - see returned ExceptionDTO
503 Service unavailable - see returned ExceptionDTO
401 Authentication required.
403 Authorization required - access forbidden

GET

Retrieves an access control object

Parameters

name description type default
id ID of the object to be retrieved path
queryEnforced "true" to query the current/enforced model, i.e. the model as it was the last time files where generated, "false" to query the pending/shadow model, i.e. the model as it will be when pending batch updates are eventually applied at some point in the future. Note that this query param is only applicable/relevant for when batched updates is enabled, if batch updates is disabled, this query param is ignored. query false

Response Body

element: (custom)
media types: application/xml
application/json

a DTO representation of the object

Status Codes

code description
200 OK
404 Not found - see returned ExceptionDTO
400 Bad request - see returned ExceptionDTO
503 Service unavailable - see returned ExceptionDTO
401 Authentication required.
403 Authorization required - access forbidden