1. Overview

Microservice containing the business logic for managing security-administration-app-service.

1.1. URI scheme

Host : localhost
BasePath : /

1.2. Tags

  • access-control-service-controller : Access Control Service Controller

  • all-resource-controller : All Resource Controller

  • privilege-controller : Privilege Controller

  • role-controller : Role Controller

  • scopes-controller : Scopes Controller

  • security-assignment-controller : Security Assignment Controller

  • user-settings-controller : User Settings Controller

2. Resources

2.1. Access-control-service-controller

Access Control Service Controller

2.1.1. Add Members To Uaa Group

POST /access-control-viewer
Parameters
Type Name Description Schema

Body

uaaRequest
required

uaaRequest

UaaGroupRequest
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.2. Get identity providers list

GET /access-control-viewer/config/identity-providers
Responses
HTTP Code Description Schema

200

OK

UserAndPrivilegeInfo

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.3. Get Assignments of a group

GET /access-control-viewer/group/assignments
Parameters
Type Name Description Schema

Query

groupId
optional

groupId

string
Responses
HTTP Code Description Schema

200

OK

UserAndPrivilegeInfo

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.4. Create Uaa Group

POST /access-control-viewer/groups
Parameters
Type Name Description Schema

Body

groupRequest
required

groupRequest

GroupRequest
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

409

Conflict - Group name conflict

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.5. Get All Groups

GET /access-control-viewer/groups
Responses
HTTP Code Description Schema

200

OK

< GroupInfo > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.6. Get All Members

GET /access-control-viewer/members
Parameters
Type Name Description Schema

Query

groupId
optional

UAA privilege id.

string

Query

privilegeName
optional

UAA privilege name.

string
Responses
HTTP Code Description Schema

200

OK

PagedUsersListResult

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.7. Add Applications To Uaa Group

POST /access-control-viewer/{groupId}/applications
Parameters
Type Name Description Schema

Path

groupId
required

groupId

string

Body

uaaRequestList
required

uaaRequestList

< UaaGroupOrMemberRequest > array
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.8. Add group in assignment

PUT /access-control-viewer/{groupId}/assignment
Parameters
Type Name Description Schema

Path

groupId
required

groupId

string

Query

assignmentId
required

assignmentId

integer (int32)
Responses
HTTP Code Description Schema

200

OK

RoleResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

424

Failed Dependency

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.9. Remove group in assignment

DELETE /access-control-viewer/{groupId}/assignment
Parameters
Type Name Description Schema

Path

groupId
required

groupId

string

Query

assignmentId
required

assignmentId

integer (int32)
Responses
HTTP Code Description Schema

200

OK

RoleResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

424

Failed Dependency

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.10. Remove Member From Uaa Group

DELETE /access-control-viewer/{groupId}/member/{memberId}
Parameters
Type Name Description Schema

Path

groupId
required

groupId

string

Path

memberId
required

memberId

string
Responses
HTTP Code Description Schema

200

OK

PagedUsersListResult

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.11. Add Members To Uaa Grouping

POST /access-control-viewer/{groupId}/members
Parameters
Type Name Description Schema

Path

groupId
required

groupId

string

Body

uaaRequest
required

uaaRequest

< UaaGroupOrMemberRequest > array
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.12. Get Groups and user info with group id

GET /access-control-viewer/{groupId}/members
Parameters
Type Name Description Schema

Path

groupId
required

groupId

string
Responses
HTTP Code Description Schema

200

OK

UserAndPrivilegeInfo

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2. All-resource-controller

All Resource Controller

2.2.1. Get All Resources

GET /resource-viewer
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3. Privilege-controller

Privilege Controller

2.3.1. Get All Privilege Sets

GET /privilege-sets-viewer
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4. Role-controller

Role Controller

2.4.1. create role

POST /role
Parameters
Type Name Description Schema

Body

rolesRequest
required

rolesRequest

RolesRequest
Responses
HTTP Code Description Schema

200

OK

RoleResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.2. Get all roles

GET /role
Parameters
Type Name Description Schema

Query

page
optional

Results page you want to retrieve (0..N)

integer (int32)

Query

size
optional

Number of records per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

RoleSearchResponseResults

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.3. Get all app level permissions

GET /role/apps
Responses
HTTP Code Description Schema

200

OK

< AppLevelPermissionsResponse > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.4. Get all scopes

GET /role/scopes
Responses
HTTP Code Description Schema

200

OK

< string > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.5. update role

PUT /role/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int32)

Body

updateRolesRequest
required

updateRolesRequest

RolesRequest
Responses
HTTP Code Description Schema

200

OK

RoleResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.6. get role by id

GET /role/{roleId}
Parameters
Type Name Description Schema

Path

roleId
required

roleId

integer (int32)
Responses
HTTP Code Description Schema

200

OK

RoleResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.7. delete role by role id

DELETE /role/{roleId}
Parameters
Type Name Description Schema

Path

roleId
required

roleId

integer (int32)
Responses
HTTP Code Description Schema

200

OK

CommonResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5. Scopes-controller

Scopes Controller

2.5.1. Get all scopes from token

GET /scopes
Responses
HTTP Code Description Schema

200

OK

< string > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.6. Security-assignment-controller

Security Assignment Controller

2.6.1. Create assignment

POST /assignment
Parameters
Type Name Description Schema

Body

assignmentsRequest
required

assignmentsRequest

AssignmentRequest
Responses
HTTP Code Description Schema

200

OK

AssignmentsResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.6.2. Get all assignment

GET /assignment
Parameters
Type Name Description Schema

Query

page
optional

Results page you want to retrieve (0..N)

integer (int32)

Query

size
optional

Number of records per page.

integer (int32)
Responses
HTTP Code Description Schema

200

OK

< AssignmentsSearchResponseResult > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.6.3. updateAssignmentsWithGroupId

PUT /assignment/group/{groupId}
Parameters
Type Name Description Schema

Path

groupId
required

groupId

string

Body

assignmentIds
required

assignmentIds

< integer (int32) > array
Responses
HTTP Code Description Schema

200

OK

object

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.6.4. Get assignment by id

GET /assignment/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int32)
Responses
HTTP Code Description Schema

200

OK

AssignmentWithResourceResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.6.5. Update assignment

PUT /assignment/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int32)

Body

assignmentsUpdateRequest
required

assignmentsUpdateRequest

AssignmentRequest
Responses
HTTP Code Description Schema

200

OK

AssignmentsResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.6.6. Remove assignment by id

DELETE /assignment/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int32)
Responses
HTTP Code Description Schema

200

OK

CommonResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7. User-settings-controller

User Settings Controller

2.7.1. Create User settings for the logged in user

POST /v2/settings
Parameters
Type Name Description Schema

Body

userSettingsRequest
optional

User Setting Object

UserSettingRequest
Responses
HTTP Code Description Schema

201

Created

UserSettingResource

204

No Content, Error retrieving created user settings

HttpErrorResponse

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

App ID not found in privilege set

HttpErrorResponse

409

Conflict, User Setting already exists. Use a PUT to update

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.2. Get User settings for the logged in User

GET /v2/settings
Parameters
Type Name Description Schema

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

UserSettingResource

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, no user setting found for the user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.3. Update User settings for the logged in user

PUT /v2/settings
Parameters
Type Name Description Schema

Body

request
optional

User Preference Object

UserSettingRequest
Responses
HTTP Code Description Schema

200

OK

UserSettingResource

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not Found, There is no saved User settings for the logged in user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Consumes

  • application/json

Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.4. Delete User settings for the logged in user

DELETE /v2/settings
Parameters
Type Name Description Schema

Query

appId
required

appId

integer (int32)

Query

viewName
required

viewName

string
Responses
HTTP Code Description Schema

200

OK

object

204

Success

object

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not Found, User Setting not found

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.5. Get Privilege Sets

GET /v2/settings/apps
Parameters
Type Name Description Schema

Query

appName
optional

appName

string
Responses
HTTP Code Description Schema

200

OK

< PrivilegeSet > array

400

Invalid data supplied

HttpErrorResponse

401

User Unauthorized

No Content

404

Not found, no user setting found for the user

HttpErrorResponse

500

Internal Server Error

HttpErrorResponse
Produces

  • application/json;charset=UTF-8

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

3. Definitions

3.1. AppLevelPermissionsResponse

Name Description Schema

description
optional

Application description

string

id
optional

Application id

integer (int32)

name
optional

Application name

string

permissionsDetailResponseList
optional

Permissions list with all information

< PermissionDetailResponse > array

3.2. AssignmentRequest

Name Description Schema

departmentIds
optional

department ids

< integer (int32) > array

description
optional

Description

string

groupIds
optional

User Group Name

< string > array

lineIds
optional

line ids

< integer (int32) > array

name
optional

Name

string

productFamilyIds
optional

product family ids

< integer (int32) > array

productIds
optional

product ids

< integer (int32) > array

roleIds
optional

role Ids

< integer (int32) > array

siteIds
optional

site ids

< integer (int32) > array

unitIds
optional

unit ids

< integer (int32) > array

3.3. AssignmentWithResourceResponse

Name Description Schema

departmentDetails
optional

Department Details

< ResourceInfo > array

description
optional

Description

string

groupDetails
optional

Group Details

< GroupDetails > array

id
optional

Id

integer (int32)

lineDetails
optional

Line Details

< ResourceInfo > array

name
optional

Name

string

productDetails
optional

Product Details

< ResourceInfo > array

productFamilyDetails
optional

Product Family Details

< ResourceInfo > array

roleDetails
optional

Role Details

< ResourceInfo > array

siteDetails
optional

Site Details

< ResourceInfo > array

unitDetails
optional

Unit Details

< ResourceInfo > array

3.4. AssignmentsResponse

Name Description Schema

createdBy
optional

string

createdDate
optional

string (date-time)

departmentIds
optional

department ids

< integer (int32) > array

description
optional

Description

string

groupDetails
optional

Group info

< GroupDetails > array

id
optional

Id

integer (int32)

lineIds
optional

line ids

< integer (int32) > array

modifiedBy
optional

string

modifiedDate
optional

string (date-time)

name
optional

Name

string

productFamilyIds
optional

product family ids

< integer (int32) > array

productIds
optional

product ids

< integer (int32) > array

roleIds
optional

role Ids

< integer (int32) > array

siteIds
optional

site ids

< integer (int32) > array

unitIds
optional

unit ids

< integer (int32) > array

3.5. AssignmentsSearchResponseResult

Name Description Schema

createdBy
optional

string

createdDate
optional

Assignment creation date

string (date-time)

description
optional

AssignemntDescription

string

id
optional

Assignment id

integer (int32)

links
optional

< Link > array

modifiedBy
optional

string

modifiedDate
optional

Assignment modification date

string (date-time)

name
optional

Assignment name

string

3.6. CommonResponse

Name Description Schema

code
optional

Response code

integer (int32)

message
optional

Common response message

string

3.7. Error

Name Schema

code
optional

string

details
optional

object

3.8. GroupDetails

Name Description Schema

displayName
optional

The unique displayName of the group

string

id
optional

The unique ID of the group

string

3.9. GroupInfo

Name Description Schema

description
optional

The description of the group

string

displayName
optional

The unique displayName of the group

string

id
optional

The unique ID of the group

string

members
optional

List of all members

< object > array

membersCount
optional

Members Count

integer (int64)

zoneId
optional

The unique displayName of the group

string

3.10. GroupMappingAssignmentResponse

Name Description Schema

assignmentDescription
optional

Assignment Description

string

assignmentId
optional

assignmentId

integer (int32)

assignmentName
optional

Assignment name

string

departmentIds
optional

Department Id

< integer (int32) > array

depts
optional

Dept Id

< string > array

groupIds
optional

Group Name

< string > array

lineIds
optional

Line Id

< integer (int32) > array

lines
optional

Line Id

< string > array

roleIds
optional

Role Ids

< integer (int32) > array

roleNames
optional

Role Name

< string > array

siteId
optional

Site Id

integer (int32)

siteNames
optional

Site Name

string

unitIds
optional

Unit Id

< integer (int32) > array

units
optional

Site Id

< string > array

3.11. GroupRequest

Name Schema

description
optional

string

displayName
optional

string

3.12. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.13. Link

Name Description Schema

href
optional

string

rel
optional

string

templated
optional

Example : false

boolean

3.14. Member

Name Description Schema

displayName
optional

Display name of the member

UserName

id
optional

The unique ID of the member

string

memberCount
optional

Member Count

integer (int64)

name
optional

Name of the member

string

type
optional

Type of the member

string

3.15. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.16. PagedUsersListResult

Name Schema

content
optional

< UsersListInfo > array

links
optional

< Link > array

page
optional

PageMetadata

3.17. PermissionDetailResponse

Name Description Schema

description
optional

Permission description

string

id
optional

Permission Id

integer (int32)

name
optional

Permission name

string

scope
optional

Permission alias name

string

3.18. PrevilegeInfo

Name Description Schema

displayName
optional

display name

string

id
optional

previlege id

string

scope
optional

scope name

string

3.19. PrivilegeSet

Name Schema

category
optional

string

description
optional

string

displayName
optional

string

icon
optional

string

id
optional

integer (int32)

scope
optional

string

3.20. ResourceInfo

Name Schema

id
optional

integer (int32)

name
optional

string

3.21. RoleResponse

Name Description Schema

createdBy
optional

string

createdDate
optional

Role Created Date

string (date-time)

description
optional

Role Description

string

id
optional

Role Id

integer (int32)

modifiedBy
optional

string

modifiedDate
optional

string (date-time)

name
optional

Role Name

string

permissions
optional

Collection of permissions

< PermissionDetailResponse > array

3.22. RoleSearchResponseResult

Name Description Schema

createdBy
optional

string

createdDate
optional

Role Created Date

string (date-time)

description
optional

Role Description

string

id
optional

Role Id

integer (int32)

links
optional

< Link > array

modifiedBy
optional

string

modifiedDate
optional

string (date-time)

name
optional

Role Name

string

3.23. RoleSearchResponseResults

Name Schema

content
optional

< RoleSearchResponseResult > array

links
optional

< Link > array

page
optional

PageMetadata

3.24. RolesRequest

Name Description Schema

description
optional

description

string

name
optional

name

string

permissionIds
optional

permission ids

< integer (int32) > array

3.25. UaaGroupOrMemberRequest

Name Description Schema

memberId
optional

Uaa member Id

string

type
optional

Uaa type Name

string

3.26. UaaGroupRequest

Name Description Schema

groupName
optional

Group Name

string

scopeName
optional

Uaa Scope Name

string

3.27. UserAndPrivilegeInfo

Name Description Schema

assignments
optional

assignments info

< GroupMappingAssignmentResponse > array

members
optional

member info

< Member > array

privileges
optional

privilege names

< PrevilegeInfo > array

3.28. UserName

Name Description Schema

familyName
optional

familyName

string

givenName
optional

givenName

string

3.29. UserSettingRequest

Name Description Schema

appId
optional

integer (int32)

data
optional

The application specific settings, Eg:- 'App Name' : {'property1' : 'value' , 'property2' : 'value'} }
Example : {
"AppKey1" : {
"property1" : { },
"property2" : { },
"property3" : { }
},
"AppKey2" : {
"property1" : { },
"property2" : { },
"property3" : { }
},
"AppKey3" : {
"property1" : { },
"property2" : { },
"property3" : { }
}
}

object

viewName
optional

string

3.30. UserSettingResource

Name Description Schema

appId
optional

integer (int32)

data
optional

object

defaultSetting
optional

Example : false

boolean

links
optional

< Link > array

viewName
optional

string

3.31. UsersListInfo

Name Description Schema

active
optional

The current status of the user
Example : false

boolean

familyName
optional

familyName

string

givenName
optional

givenName

string

id
optional

The unique ID of the user

string

links
optional

< Link > array

name
optional

The name of the user

UserName

userId
optional

string

userName
optional

The userName/login in of the user

string

4. Security

4.1. access_token

Type : oauth2
Flow : accessCode
Token URL : https://alpha2-pa/uaa/oauth/authorize
Token URL : https://alpha2-pa/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.2. resource_owner

Type : oauth2
Flow : password
Token URL : https://alpha2-pa/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

Type : oauth2
Flow : implicit
Token URL : https://alpha2-pa/uaa/oauth/authorize

Name Description

default

Default oauth2 scope.

4.4. client_creds

Type : oauth2
Flow : application
Token URL : https://alpha2-pa/uaa/oauth/token

Name Description

default

Default oauth2 scope.