SecuritySystemResource Resource

Resource for managing system security permissions.

Available Since
1.31

GET /api/rest/security/permission/group/{group}

Returns all permissions of the user or group managed by the resource.

Request Parameters
name type description
group path name of group
Response Codes
code condition
204 success
500 internal server error
Response Body
media type data type description
application/json array of Permission (JSON) all permissions of the user or group
application/xml list of permission (XML)

Example

Request
GET /security/permission/group/{group}
Accept: application/json

              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
[ {
  "id" : "...",
  "value" : "..."
} ]
                
              
Available Since
1.31

POST /api/rest/security/permission/group/{group}

Adds a new permission to the user or group managed by the resource.

Request Parameters
name type description
group path name of group
Request Body
media type data type description
application/json Permission (JSON) permission to add
application/xml permission (XML)
Response Codes
code condition
201 creates
500 internal server error

Example

Request
POST /security/permission/group/{group}
Content-Type: application/json

                
{
  "id" : "...",
  "value" : "..."
}
                
              
Response
HTTP/1.1 201 Created

              
Available Since
1.31

GET /api/rest/security/permission/user/{user}

Returns all permissions of the user or group managed by the resource.

Request Parameters
name type description
user path name of user
Response Codes
code condition
204 success
500 internal server error
Response Body
media type data type description
application/json array of Permission (JSON) all permissions of the user or group
application/xml list of permission (XML)

Example

Request
GET /security/permission/user/{user}
Accept: application/json

              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
[ {
  "id" : "...",
  "value" : "..."
} ]
                
              
Available Since
1.31

POST /api/rest/security/permission/user/{user}

Adds a new permission to the user or group managed by the resource.

Request Parameters
name type description
user path name of user
Request Body
media type data type description
application/json Permission (JSON) permission to add
application/xml permission (XML)
Response Codes
code condition
201 creates
500 internal server error

Example

Request
POST /security/permission/user/{user}
Content-Type: application/json

                
{
  "id" : "...",
  "value" : "..."
}
                
              
Response
HTTP/1.1 201 Created

              
Available Since
1.31

DELETE /api/rest/security/permission/group/{group}/{id}

Deletes a permission from the user or group managed by the resource.

Request Parameters
name type description
group path name of group
id path id of the permission
Response Codes
code condition
204 success
400 bad request, permission id does not belong to the user or group
404 not found, no permission with the specified id available
500 internal server error

Example

Request
DELETE /security/permission/group/{group}/{id}

              
Response
HTTP/1.1 204 No Content

              
Available Since
1.31

GET /api/rest/security/permission/group/{group}/{id}

Returns the Permission with the specified id.

Request Parameters
name type description
group path name of group
id path id of the Permission
Response Codes
code condition
204 success
400 bad request, permission id does not belong to the user or group
404 not found, no permission with the specified id available
500 internal server error
Response Body
media type data type description
application/json Permission (JSON) Permission with the specified id
application/xml permission (XML)

Example

Request
GET /security/permission/group/{group}/{id}
Accept: application/json

              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "id" : "...",
  "value" : "..."
}
                
              
Available Since
1.31

PUT /api/rest/security/permission/group/{group}/{id}

Updates the specified permission on the user or group managed by the resource.

Request Parameters
name type description
group path name of group
id path id of the permission
Request Body
media type data type description
application/json Permission (JSON) updated permission
application/xml permission (XML)
Response Codes
code condition
204 success
400 bad request, permission id does not belong to the user or group
404 not found, no permission with the specified id available
500 internal server error

Example

Request
PUT /security/permission/group/{group}/{id}
Content-Type: application/json

                
{
  "id" : "...",
  "value" : "..."
}
                
              
Response
HTTP/1.1 204 No Content

              
Available Since
1.31

DELETE /api/rest/security/permission/user/{user}/{id}

Deletes a permission from the user or group managed by the resource.

Request Parameters
name type description
id path id of the permission
user path name of user
Response Codes
code condition
204 success
400 bad request, permission id does not belong to the user or group
404 not found, no permission with the specified id available
500 internal server error

Example

Request
DELETE /security/permission/user/{user}/{id}

              
Response
HTTP/1.1 204 No Content

              
Available Since
1.31

GET /api/rest/security/permission/user/{user}/{id}

Returns the Permission with the specified id.

Request Parameters
name type description
id path id of the Permission
user path name of user
Response Codes
code condition
204 success
400 bad request, permission id does not belong to the user or group
404 not found, no permission with the specified id available
500 internal server error
Response Body
media type data type description
application/json Permission (JSON) Permission with the specified id
application/xml permission (XML)

Example

Request
GET /security/permission/user/{user}/{id}
Accept: application/json

              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "id" : "...",
  "value" : "..."
}
                
              
Available Since
1.31

PUT /api/rest/security/permission/user/{user}/{id}

Updates the specified permission on the user or group managed by the resource.

Request Parameters
name type description
id path id of the permission
user path name of user
Request Body
media type data type description
application/json Permission (JSON) updated permission
application/xml permission (XML)
Response Codes
code condition
204 success
400 bad request, permission id does not belong to the user or group
404 not found, no permission with the specified id available
500 internal server error

Example

Request
PUT /security/permission/user/{user}/{id}
Content-Type: application/json

                
{
  "id" : "...",
  "value" : "..."
}
                
              
Response
HTTP/1.1 204 No Content