1. Overview

Microservice containing the business logic for managing security-service.

1.1. URI scheme

Host : localhost
BasePath : /

1.2. Tags

  • assignment-controller : Assignment Controller

  • permission-check-controller : Permission Check Controller

  • permission-controller : Permission Controller

  • permission-group-controller : Permission Group Controller

  • permission-inclusions-controller : Permission Inclusions Controller

  • permissions-group-mapping-controller : Permissions Group Mapping Controller

  • privilege-set-controller : Privilege Set Controller

  • role-controller : Role Controller

  • user-controller : User Controller

2. Resources

2.1. Assignment-controller

Assignment Controller

2.1.1. Create assignment

POST /assignments
Parameters
Type Name Description Schema

Body

assignment
required

assignment

AssignmentsRequest

Responses
HTTP Code Description Schema

201

Created

AssignmentResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server error

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Consumes
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.2. Get Assignments

GET /assignments
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

AssignmentsSearchResponseResults

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json

  • application/vnd.ge.mes.v1.full+json

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 /assignments/group/assignments
Parameters
Type Name Description Schema

Query

groupId
optional

groupId

string

Responses
HTTP Code Description Schema

200

OK

< GroupMappingAssignmentResponse > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.4. Get user groups and permission level resources

GET /assignments/resources
Parameters
Type Name Description Schema

Query

permissionName
required

Permission scope Name

string

Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.5. Get assignment By Id

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

Path

id
required

id

integer (int32)

Responses
HTTP Code Description Schema

200

OK

AssignmentResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.6. Update assignment

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

Path

id
required

id

integer (int32)

Body

assignment
required

assignment

AssignmentsRequest

Responses
HTTP Code Description Schema

200

OK

AssignmentResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Consumes
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.1.7. Remove assignment By Id

DELETE /assignments/{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

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2. Permission-check-controller

Permission Check Controller

2.2.1. Check resource level and user groups permission

GET /checkPermission
Parameters
Type Name Description Schema

Query

permissionName
optional

Permission scope Name

string

Query

resourceId
optional

Resource Id( Unit or Line or Department or Site)

integer (int32)

Query

resourceType
optional

Type of the resource (Unit or Line or Department or Site)

string

Responses
HTTP Code Description Schema

200

OK

object

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3. Permission-controller

Permission Controller

2.3.1. Create permission

POST /permissions
Parameters
Type Name Description Schema

Body

permission
required

permission

PermissionRequest

Responses
HTTP Code Description Schema

201

Created

PermissionSearchResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Consumes
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3.2. Get permissions

GET /permissions
Parameters
Type Name Description Schema

Query

appPermissions
optional

include / exclude app permission.

boolean

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

PermissionSearchResponseResults

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3.3. Get permission by id

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

Path

id
required

id

integer (int32)

Responses
HTTP Code Description Schema

200

OK

PermissionSearchResponseResult

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3.4. Update permission

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

Path

id
required

id

integer (int32)

Body

permission
required

permission

PermissionRequest

Responses
HTTP Code Description Schema

200

OK

PermissionSearchResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Consumes
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3.5. Remove permission by id

DELETE /permissions/{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

Service Unavailable

HttpErrorResponse

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4. Permission-group-controller

Permission Group Controller

2.4.1. Create Permission Group (app group)

POST /permission-group
Parameters
Type Name Description Schema

Body

permissionGroupingRequest
required

permissionGroupingRequest

PermissionGroupingRequest

Responses
HTTP Code Description Schema

201

Created

PermissionGroupingResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Consumes
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.2. Get permission groups

GET /permission-group
Responses
HTTP Code Description Schema

200

OK

< PermissionGroupingResponse > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.3. Get permission group by id

GET /permission-group/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int32)

Responses
HTTP Code Description Schema

200

OK

PermissionGroupingResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.4. Update permission group(app grouping)

PUT /permission-group/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int32)

Body

permissionGrouping
required

permissionGrouping

PermissionGroupingRequest

Responses
HTTP Code Description Schema

200

OK

PermissionGroupingResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Consumes
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.4.5. Remove permission (app) group by id

DELETE /permission-group/{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

Service Unavailable

HttpErrorResponse

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5. Permission-inclusions-controller

Permission Inclusions Controller

2.5.1. Create inclusions- to map core scope permission to app scope permission

POST /permission-inclusions
Parameters
Type Name Description Schema

Body

permissionInclusionRequest
required

permissionInclusionRequest

PermissionInclusionRequest

Responses
HTTP Code Description Schema

201

Created

PermissionInclusionResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Consumes
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.2. Get permission Inclusion mappings

GET /permission-inclusions
Parameters
Type Name Description Schema

Query

appPermissionId
optional

appPermissionId

integer (int32)

Query

corePermissionId
optional

corePermissionId

integer (int32)

Responses
HTTP Code Description Schema

200

OK

< PermissionInclusionResponse > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.5.3. Remove permission Inclusion by appPermissionId and corePermissionId

DELETE /permission-inclusions/{appPermissionId}
Parameters
Type Name Description Schema

Path

appPermissionId
required

appPermissionId

integer (int32)

Query

corePermissionId
required

corePermissionId

integer (int32)

Responses
HTTP Code Description Schema

200

OK

CommonResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Service Unavailable

HttpErrorResponse

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.6. Permissions-group-mapping-controller

Permissions Group Mapping Controller

2.6.1. Create permission group mapping

POST /permission-group-mapping
Parameters
Type Name Description Schema

Body

permission
required

permission

PermissionGroupDetails

Responses
HTTP Code Description Schema

201

Created

PermissionSearchResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Internal Server

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Consumes
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.6.2. Get app group permission mapping

GET /permission-group-mapping
Parameters
Type Name Description Schema

Query

appGroupId
optional

Application Group Id

integer (int32)

Query

permissionId
optional

App permission Id

integer (int32)

Responses
HTTP Code Description Schema

200

OK

< PermissionSearchResponse > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.6.3. Remove permission mapping by group id

DELETE /permission-group-mapping/groups/{id}
Parameters
Type Name Description Schema

Path

id
required

id

integer (int32)

Query

permissionId
required

permissionId

integer (int32)

Responses
HTTP Code Description Schema

200

OK

CommonResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Service Unavailable

HttpErrorResponse

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7. Privilege-set-controller

Privilege Set Controller

2.7.1. Get all privilege Sets details

GET /privilegeSets
Responses
HTTP Code Description Schema

200

OK

< PrivilegeSet > array

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.7.2. Get PrivilegeName by privilegeId

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

Path

id
required

id

integer (int32)

Responses
HTTP Code Description Schema

200

OK

PrivilegeName

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.8. Role-controller

Role Controller

2.8.1. Create role

POST /roles
Parameters
Type Name Description Schema

Body

roleRequest
required

roleRequest

RoleRequest

Responses
HTTP Code Description Schema

201

Created

RoleResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Consumes
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.8.2. Get all roles

GET /roles
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

500

Service Unavailable

HttpErrorResponse

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.8.3. Search all apps level permissions

GET /roles/apps
Responses
HTTP Code Description Schema

200

OK

< AppLevelPermissionsResponse > array

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.8.4. Get role by id

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

Path

id
required

id

integer (int32)

Responses
HTTP Code Description Schema

200

OK

RoleResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Service Unavailable

HttpErrorResponse

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.8.5. update role

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

Path

id
required

id

integer (int32)

Body

roleUpdateRequest
required

roleUpdateRequest

RoleRequest

Responses
HTTP Code Description Schema

201

Created

RoleResponse

400

Bad Request

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

404

Not Found

HttpErrorResponse

500

Service Unavailable

HttpErrorResponse

Consumes
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.create+json

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.8.6. Delete role by id

DELETE /roles/{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

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json;charset=UTF-8

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.9. User-controller

User Controller

2.9.1. Get all PA Users details

GET /users
Parameters
Type Name Description Schema

Query

isActive
optional

isActive

boolean

Query

page
optional

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

integer (int32)

Query

size
optional

Number of records per page.

integer (int32)

Query

username
optional

username

string

Responses
HTTP Code Description Schema

200

OK

UserInfoResults

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json

  • application/vnd.ge.mes.v1.full+json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.9.2. Get PA User Details

GET /users/{userId}
Parameters
Type Name Description Schema

Path

userId
required

userId

integer (int32)

Responses
HTTP Code Description Schema

200

OK

UserInfo

401

Unauthorized

HttpErrorResponse

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse

Produces
  • application/json

  • application/vnd.ge.mes.v1.full+json

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. AssignmentResponse

Name Description Schema

createdBy
optional

string

createdDate
optional

string (date-time)

departmentIds
optional

department ids

< integer (int32) > array

description
optional

Description

string

groupIds
optional

Group ids

< string > 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.3. AssignmentsRequest

Name Description Schema

departmentIds
optional

Resource department ids

< integer (int32) > array

description
optional

Assignment description

string

groupIds
optional

Group Ids

< string > array

lineIds
optional

Resource line ids

< integer (int32) > array

name
optional

Assignment name

string

productFamilyIds
optional

Resource family ids

< integer (int32) > array

productIds
optional

Resource product ids

< integer (int32) > array

roleIds
optional

Role Ids

< integer (int32) > array

siteIds
optional

Resource site ids

< integer (int32) > array

unitIds
optional

Resource unit ids

< integer (int32) > array

3.4. 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.5. AssignmentsSearchResponseResults

Name Schema

content
optional

< AssignmentsSearchResponseResult > array

links
optional

< Link > array

page
optional

PageMetadata

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. GroupInfo

Name Description Schema

id
optional

Group id

integer (int32)

name
optional

Group name

string

3.9. 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.10. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

Name Schema

href
optional

string

rel
optional

string

templated
optional

boolean

3.12. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.13. 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.14. PermissionGroupDetails

Name Description Schema

applications
optional

Application ids

< integer (int32) > array

permissionId
optional

Permission Id

integer (int32)

3.15. PermissionGroupingRequest

Name Description Schema

description
optional

Permission description

string

name
optional

Permission name

string

3.16. PermissionGroupingResponse

Name Description Schema

createdBy
optional

string

createdDate
optional

Permission grouping Created Date

string (date-time)

description
optional

Permission grouping description

string

id
optional

Permission grouping id

integer (int32)

modifiedBy
optional

string

modifiedDate
optional

string (date-time)

name
optional

Permission grouping name

string

3.17. PermissionInclusionRequest

Name Description Schema

appPermissionId
optional

App Permission Id

integer (int32)

corePermissionId
optional

Core Permission Id

integer (int32)

3.18. PermissionInclusionResponse

Name Description Schema

appPermissionId
optional

App Permission id

integer (int32)

permissionId
optional

Core Permission Id

integer (int32)

3.19. PermissionRequest

Name Description Schema

description
optional

Permission description

string

isAppPermission
optional

Permission type app or core
Example : false

boolean

name
optional

Permission name

string

scope
optional

Unique name for permission as scope

string

3.20. PermissionSearchResponse

Name Description Schema

appPermission
optional

boolean

applications
optional

Group ids

< GroupInfo > array

createdBy
optional

string

createdDate
optional

Role Created Date

string (date-time)

description
optional

Description

string

id
optional

Id

integer (int32)

modifiedBy
optional

string

modifiedDate
optional

string (date-time)

name
optional

Name

string

scope
optional

scope

string

3.21. PermissionSearchResponseResult

Name Description Schema

appPermission
optional

boolean

applications
optional

Group ids

< GroupInfo > array

createdBy
optional

string

createdDate
optional

Role Created Date

string (date-time)

description
optional

Description

string

id
optional

Id

integer (int32)

links
optional

< Link > array

modifiedBy
optional

string

modifiedDate
optional

string (date-time)

name
optional

Name

string

scope
optional

scope

string

3.22. PermissionSearchResponseResults

Name Schema

content
optional

< PermissionSearchResponseResult > array

links
optional

< Link > array

page
optional

PageMetadata

3.23. PrivilegeName

Name Description Schema

id
optional

Privilege Id

integer (int32)

name
optional

Privilege Name

string

3.24. PrivilegeSet

Name Schema

category
optional

string

description
optional

string

displayName
optional

string

icon
optional

string

id
optional

integer (int32)

scope
optional

string

3.25. RoleRequest

Name Description Schema

description
optional

description

string

name
optional

name

string

permissionIds
optional

permission ids

< integer (int32) > array

3.26. 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.27. 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.28. RoleSearchResponseResults

Name Schema

content
optional

< RoleSearchResponseResult > array

links
optional

< Link > array

page
optional

PageMetadata

3.29. UserInfo

Name Description Schema

active
optional

Active
Example : false

boolean

description
optional

User Description

string

id
optional

User Id

integer (int32)

isRole
optional

Role
Example : false

boolean

username
optional

User Name

string

3.30. UserInfoResult

Name Description Schema

active
optional

Active
Example : false

boolean

description
optional

User Description

string

id
optional

User Id

integer (int32)

isRole
optional

Role
Example : false

boolean

links
optional

< Link > array

username
optional

User Name

string

3.31. UserInfoResults

Name Schema

content
optional

< UserInfoResult > array

links
optional

< Link > array

page
optional

PageMetadata

4. Security

4.1. access_token

Name Description

default

Default oauth2 scope.

4.2. resource_owner

Type : oauth2
Flow : password
Token URL : https://10.181.213.187:8443/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

Type : oauth2
Flow : implicit
Token URL : https://10.181.213.187:8443/uaa/oauth/authorize

Name Description

default

Default oauth2 scope.

4.4. client_creds

Type : oauth2
Flow : application
Token URL : https://10.181.213.187:8443/uaa/oauth/token

Name Description

default

Default oauth2 scope.