MyselfResource

Perform queries relating to the currently logged in user Copyright 2017 WANdisco.

The following resources are part of this group:

/myself

Mount Point: /myself

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

/myself/audit

Mount Point: /myself/audit

GET

Gets the latest audit record for the current logged in user

Response Body

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

HTTP Response Code When
401 Authentication (AuthN) failure Unable to authenticate the user making the request
403 Authorization (AuthZ) failure The user making the request was authenticated, but is not authorized to perform this request.
200 OK An account was found matching the supplied accountId, and the latest audit record for that account is returned in a AuditRecordDTO
400 BAD REQUEST No accountId was supplied, or a null or empty accountId was supplied
500 INTERNAL SERVER ERROR If some unexpected problem occurred during processing of the request.

Status Codes

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

/myself/permissions

Mount Point: /myself/permissions

GET

Return current user permissions

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: rootpermission
media types: application/xml
application/json

(no documentation provided)

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

/myself/publickey

Mount Point: /myself/publickey

POST

Replaces the current user's public SSH keys with a new list, the new list can contain multiple keys. example call: curl --user : -d "[{\"sshKey\": \"testSSHKey\", \"local\": \"true\", \"alias\": \"testKeyAlias\"}]" -H "Content-Type: application/json" http://127.0.0.1:8082/api/myself/publickey

Request Body

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

Accepts a list of current key(s) which make up the current user's new public SSH key list.

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
401 Authentication required.
403 Authorization required - access forbidden

/myself/teams

Mount Point: /myself/teams

GET

Retrieve 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: pagedresultlist
media types: application/xml
application/json

a PagedResultListDTO of returned 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

/myself/user

Mount Point: /myself/user

GET

Returns the currently logged in user

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: user
media types: application/xml
application/json

(no documentation provided)

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

/myself/{id}

Mount Point: /myself/{id}

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

/myself/password/change

Mount Point: /myself/password/change

PUT

Changes the authenticating user's current password.

Request Body

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

should contain the authenticating user's current password, and a new password which will replace the current one. The new password should not be empty.

Response Body

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

ID of the task monitoring the password change 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

/myself/{team_id}/permissions

Mount Point: /myself/{team_id}/permissions

GET

Return current user admin permissions for 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 path

Response Body

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

(no documentation provided)

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