TeamResource

TeamResource REST endpoint for querying and manipulating ACP teams Copyright 2014 WANdisco.

The following resources are part of this group:

/teams

Mount Point: /api/teams

GET

Retrieves a list of teams

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 name
searchKeyList list of keys to search by query
searchValueList list of values to search for query

Response Body

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

a PagedResultListDTO of TeamDTOs

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

POST

Create a team

Request Body

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

TeamDTO representation of the team to be created

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

/teams/counts

Mount Point: /api/teams/counts

GET

Retrieve a count of total teams

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
id list of target teams query

Response Body

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

a List of counts

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

/teams/rules

Mount Point: /api/teams/rules

GET

Retrieve all team rules

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 ruleName
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

PagedResultListDTO of RuleDTOs

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

/teams/{id}

Mount Point: /api/teams/{id}

The following operations are supported on this resource:

GET

Retrieves a team

Parameters

name description type default
id ID of the team 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: team
media types: application/xml
application/json

(no documentation provided)

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

PUT

Update a team

Parameters

name description type default
id target team ID path

Request Body

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

TeamDTO representation of the edited team

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

/teams/rules/counts

Mount Point: /api/teams/rules/counts

GET

Get user/resource counts for specified rules

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
id list of rule IDs to be queried query

Response Body

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

a List of CountsDTO

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

/teams/{team_id}/leaders

Mount Point: /api/teams/{team_id}/leaders

GET

Retrieve a list of team leaders

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
team_id the target team ID path
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 ownerUser
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

PagedResultListDTO of TeamAdminPermissionDTOs

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

/teams/{team_id}/members

Mount Point: /api/teams/{team_id}/members

POST

Adds multiple users to a team

Parameters

name description type default
team_id target team ID path

Request Body

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

target user IDs to be added

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

GET

Retrieve the member users of a team

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
team_id the target team ID path
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 username
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

PagedResultListDTO of UserDTOs

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

/teams/{team_id}/resources

Mount Point: /api/teams/{team_id}/resources

GET

Retrieve the resources of a specified team

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
team_id target team ID path
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 repositoryName
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

PagedResultListDTO of ResourceDTOs

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

POST

Add a resource to a team

Parameters

name description type default
team_id target team ID path

Request Body

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

resource to add

Response Body

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

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

/teams/{team_id}/rules

Mount Point: /api/teams/{team_id}/rules

POST

Creates a team rule

Parameters

name description type default
team_id the target team ID path

Request Body

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

rule to apply

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 a list of available team leaders

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
team_id the target team ID path
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 ruleName
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

PagedResultListDTO of RuleDTOs

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

/teams/{team_id}/subteams

Mount Point: /api/teams/{team_id}/subteams

GET

Retrieves the subteams of a given team

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
team_id target team ID path
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 name
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

PagedResultListDTO of TeamDTOs

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

POST

Create a subteam

Parameters

name description type default
team_id target parent team path

Request Body

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

subteam details

Response Body

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

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

/teams/rules/counts/all

Mount Point: /api/teams/rules/counts/all

GET

Retrieve a count of all rules

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

Response Body

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

(no documentation provided)

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

/teams/{team_id}/leaders/available

Mount Point: /api/teams/{team_id}/leaders/available

GET

Retrieve a list of available team leaders

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 (no documentation provided) query 20
pageNumber (no documentation provided) query 1
team_id the target team ID path
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 username
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

PagedResultListDTO of TeamAdminPermissionDTOs

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

/teams/{team_id}/leaders/{user_id}

Mount Point: /api/teams/{team_id}/leaders/{user_id}

The following operations are supported on this resource:

POST

Adds a team admin permission to the given user

Parameters

name description type default
team_id the target team ID path
user_id the target user ID path

Request Body

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

admin permission to apply

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

Response Headers

name description
X-entity-id Team admin permission ID

GET

Retrieves any admin permissions of this team associated for the specified user

Parameters

name description type default
team_id the target team ID path
user_id the target user ID 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: teamadminpermission
media types: application/xml
application/json

(no documentation provided)

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

DELETE

Adds a team admin permission of the given user

Parameters

name description type default
team_id the target team ID path
user_id the target user ID path

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

PUT

updates a team admin permission to the given user

Parameters

name description type default
team_id the target team ID path
user_id the target user ID path

Request Body

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

admin permission to apply

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

/teams/{team_id}/members/available

Mount Point: /api/teams/{team_id}/members/available

GET

Retrieve the available member users in a team

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
team_id the target team ID path
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

PagedResultListDTO of UserDTOs

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

/teams/{team_id}/members/counts

Mount Point: /api/teams/{team_id}/members/counts

GET

A count of users in a team

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
team_id target team path
id target team members query

Response Body

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

a List of counts

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

/teams/{team_id}/members/delete

Mount Point: /api/teams/{team_id}/members/delete

POST

Remove multiple users from a team

Parameters

name description type default
team_id target team ID path

Request Body

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

list of user IDs to remove

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

/teams/{team_id}/members/new

Mount Point: /api/teams/{team_id}/members/new

POST

Creates a user and adds that user to a specific team.

Note, this operation is permitted for system admins and team leaders only.Standard non-team leader users are not authorized to use perform this operation.

Parameters

name description type default
team_id the id of team to which the newly created user will be added to. path

Request Body

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

the user to create

Response Body

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

HTTP Response Code When
202 ACCEPTED The request was accepted for processing. The DCone task id will also be returned in this case so the completion of the request (i.e. the creation of a user and the addition of that newly created user to a team) can be checked for success or failure.
403 FORBIDDEN If a standard non-team leader user is attempting to perform this operation, or the user performing this operation is a team leader, but not of the team specified in the request.
400 BAD REQUEST If the user represented by the userDTO argument already exists.
400 BAD REQUEST If the user represented by the userDTO is a local user and local users are disallowed by the application.
400 BAD REQUEST If no team exists matching the teamId argument.
400 BAD REQUEST If the user being created and added to the team needs to be added to one or more parent team(s) they are not already members of, but the user making the request does not have the appropriate permissions to add them to one or more parent team(s).
500 INTERNAL SERVER ERROR If some unexpected problem occurred during processing of the request.

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

/teams/{team_id}/members/{user_id}

Mount Point: /api/teams/{team_id}/members/{user_id}

POST

Adds a user to a team

Parameters

name description type default
team_id target team path
user_id target user path

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

Removes a user from a team

Parameters

name description type default
team_id target team path
user_id target user to be removed path

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

/teams/{team_id}/resources/available

Mount Point: /api/teams/{team_id}/resources/available

GET

Retrieve the available resources of a specified team

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
team_id target team ID path
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 repositoryName
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

PagedResultListDTO of ResourceDTOs

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

/teams/{team_id}/resources/delete

Mount Point: /api/teams/{team_id}/resources/delete

POST

Deletes the specified resources from a team

Parameters

name description type default
team_id target team ID path

Request Body

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

list of resource IDs to delete

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

/teams/{team_id}/rules/counts

Mount Point: /api/teams/{team_id}/rules/counts

GET

A count of rules in a team

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
team_id target team path
id target rules query

Response Body

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

a List of counts

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

/teams/{team_id}/rules/{rule_id}

Mount Point: /api/teams/{team_id}/rules/{rule_id}

The following operations are supported on this resource:

GET

Retrieves the specified rule

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
team_id parent team ID path
rule_id target rule ID path

Response Body

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

(no documentation provided)

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 the specified rule

Parameters

name description type default
team_id parent team ID path
rule_id target rule ID path

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

PUT

Updates the specified rule

Parameters

name description type default
team_id parent team ID path
rule_id target rule ID path

Request Body

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

the updated rule

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

/teams/{team_id}/testConnection/{ldap_authority_id}

Mount Point: /api/teams/{team_id}/testConnection/{ldap_authority_id}

POST

Perform a test connection to the specified LDAP authority for this team

Parameters

name description type default
team_id the target team path
ldap_authority_id the target LDAP authority path
pageSize number of results to return query 20
filter optional query filter query

Response Body

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

TestConnectionResultDTO of results

Status Codes

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

/teams/{team_id}/rules/{rule_id}/members

Mount Point: /api/teams/{team_id}/rules/{rule_id}/members

POST

Adds users to a rule

Parameters

name description type default
team_id parent team ID path
rule_id target rule ID path

Request Body

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

list of user IDs to add

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

GET

Retrieve the users associated with a rule

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
team_id parent team ID path
rule_id target rule ID path
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 username
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

PagedResultListDTO of UserDTOs

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

/teams/{team_id}/rules/{rule_id}/resourcepermissions

Mount Point: /api/teams/{team_id}/rules/{rule_id}/resourcepermissions

The following operations are supported on this resource:

POST

Add resource permissions to a rule A sample xml encoded payload: 


<?xml version="1.0" encoding="UTF-8"?>
<dtolist>
<DTOs xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="resourcePermissionDTO">
<permissionType>READ_WRITE</permissionType>
<path></path>
<ownerRule>21979696-fc56-4dd8-aac1-2289f383bcd0</ownerRule>
<ownerResource>d5d31e0b-7633-4bb7-a5cb-b510cf00277d</ownerResource>
</DTOs>
<!-- if we need more
<DTOs xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="resourcePermissionDTO">
<permissionType>READ_WRITE</permissionType>
<path></path>
<ownerRule>21979696-fc56-4dd8-aac1-2289f383bcd0</ownerRule>
<ownerResource>d5d31e0b-7633-4bb7-a5cb-b510cf00277d</ownerResource>
</DTOs>
-->
</dtolist>

Parameters

name description type default
team_id parent team ID path
rule_id target rule ID path

Request Body

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

list of resource permissions to add

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

GET

Retrieve the resource permissions associated with a rule

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
team_id parent team ID path
rule_id target rule ID path
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 path
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

PagedResultListDTO of ResourcePermissionDTOs

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

PUT

Edit rule resource permissions

Parameters

name description type default
team_id parent team ID path
rule_id target rule ID path

Request Body

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

list of edited resource permissions

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

/teams/{team_id}/rules/{rule_id}/members/available

Mount Point: /api/teams/{team_id}/rules/{rule_id}/members/available

GET

Retrieve the available users associated with a rule

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
team_id parent team ID path
rule_id target rule ID path
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 username
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

PagedResultListDTO of UserDTOs

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

/teams/{team_id}/rules/{rule_id}/members/delete

Mount Point: /api/teams/{team_id}/rules/{rule_id}/members/delete

POST

Remove the specified users from the rule

Parameters

name description type default
team_id parent team ID path
rule_id target rule ID path

Request Body

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

list of user IDs to remove

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

/teams/{team_id}/rules/{rule_id}/resourcepermissions/delete

Mount Point: /api/teams/{team_id}/rules/{rule_id}/resourcepermissions/delete

POST

Delete resource permissions from a rule

Parameters

name description type default
team_id parent team ID path
rule_id target rule ID path

Request Body

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

IDs of permissions to remove

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