1. Overview

Microservice containing the business logic for managing access-control-service.

1.1. URI scheme

Host : localhost
BasePath : /

1.2. Tags

  • uaa-config-controller : Uaa Config Controller

  • user-controller : User Controller

  • user-groups-controller : User Groups Controller

2. Resources

2.1. Uaa-config-controller

Uaa Config Controller

2.1.1. Get identity providers list

GET /UAA/config/identity-providers
Responses
HTTP Code Description Schema

200

OK

< IdentityProviderInfo > array

400

Bad Request - Invalid attributes

No Content

401

Unauthorized

No Content

403

Forbidden - Insufficient scope

No Content
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. User-controller

User Controller

2.2.1. Get UAA Clients

GET /UAA/clients
Parameters
Type Name Description Schema

Query

clientName
optional

UAA client name/id.

string

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

object

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.2. Get UAA User

GET /UAA/user/{userId}
Parameters
Type Name Description Schema

Path

userId
required

UAA user id.

string
Responses
HTTP Code Description Schema

200

OK

UserInfo

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.3. Get UAA User with groups

GET /UAA/user/{userId}/groups
Parameters
Type Name Description Schema

Path

userId
required

UAA user id.

string
Responses
HTTP Code Description Schema

200

OK

UserInfoWithGroups

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.2.4. Get UAA Users

GET /UAA/users
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)

Query

username
optional

UAA user name.

string
Responses
HTTP Code Description Schema

200

OK

PagedUsersListResult

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3. User-groups-controller

User Groups Controller

2.3.1. Create a uaa group

POST /UAA/groups
Parameters
Type Name Description Schema

Body

groupRequest
required

groupRequest

GroupRequest
Responses
HTTP Code Description Schema

200

OK

GroupInfo

201

Created successfully

GroupInfo

400

Bad Request - Invalid member ID

HttpUAAErrorResponse

401

Unauthorized

No Content

403

Forbidden - Insufficient scope

No Content
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 UAA User groups

GET /UAA/groups
Parameters
Type Name Description Schema

Query

displayName
optional

UAA group display name.

string

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

GroupsResponse

400

Bad Request - Invalid attributes

No Content

401

Unauthorized

No Content

403

Forbidden - Insufficient scope

No Content
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.3. Get group by id

GET /UAA/groups/{groupId}
Parameters
Type Name Description Schema

Path

groupId
required

groupId

string
Responses
HTTP Code Description Schema

200

OK

GroupInfo

401

Unauthorized

No Content

403

Forbidden

HttpErrorResponse

404

Not Found

HttpUAAErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3.4. Remove group from UAA

DELETE /UAA/groups/{groupId}
Parameters
Type Name Description Schema

Path

groupId
required

groupId

string
Responses
HTTP Code Description Schema

200

OK

MemberInfo

400

Incorrect version supplied in If-Match header

HttpErrorResponse

401

Unauthorized

No Content

403

Insufficient scope

HttpErrorResponse

404

Group does not exist, or the entity is not a member

HttpUAAErrorResponse

409

Conflict

HttpUAAErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3.5. Creates a group mapping with an internal UAA groups as members

POST /UAA/groups/{groupId}/members
Parameters
Type Name Description Schema

Path

groupId
required

groupId

string

Body

memberMapRequest
required

memberMapRequest

GroupMemberMapRequest
Responses
HTTP Code Description Schema

200

OK

MemberInfo

400

Bad Request - Invalid member ID

No Content

401

Unauthorized

No Content

403

Forbidden, Insufficient scope

No Content

404

Not Found - Specified group or member entity does not exist

HttpUAAErrorResponse
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.6. Get members of a group

GET /UAA/groups/{groupId}/members
Parameters
Type Name Description Schema

Path

groupId
required

groupId

string
Responses
HTTP Code Description Schema

200

OK

< MemberInfo > array

400

Bad Request - Invalid attributes

HttpErrorResponse

401

Unauthorized

HttpErrorResponse

403

Forbidden - Insufficient scope

HttpErrorResponse

404

Not Found - Specified group does not exist

HttpUAAErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3.7. Check Membership of a member in a group

GET /UAA/groups/{groupId}/members/{memberId}
Parameters
Type Name Description Schema

Path

groupId
required

groupId

string

Path

memberId
required

memberId

string
Responses
HTTP Code Description Schema

200

OK

MemberInfo

400

Incorrect version supplied in If-Match header

HttpErrorResponse

401

Unauthorized

No Content

403

Insufficient scope

HttpErrorResponse

404

Group does not exist, or the entity is not a member

HttpUAAErrorResponse

409

Conflict

HttpUAAErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/json

Security
Type Name Scopes

oauth2

access_token

default

oauth2

client_creds

default

oauth2

resource_owner

default

oauth2

implicit_grant

default

2.3.8. Remove Member from the group

DELETE /UAA/groups/{groupId}/members/{memberId}
Parameters
Type Name Description Schema

Path

groupId
required

groupId

string

Path

memberId
required

memberId

string
Responses
HTTP Code Description Schema

200

OK

MemberInfo

400

Incorrect version supplied in If-Match header

HttpErrorResponse

401

Unauthorized

No Content

403

Insufficient scope

HttpErrorResponse

404

Group does not exist, or the entity is not a member

HttpUAAErrorResponse

409

Conflict

HttpUAAErrorResponse

503

Service Unavailable

HttpErrorResponse
Produces

  • application/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. Error

Name Schema

code
optional

string

details
optional

object

3.2. GroupData

Name Description Schema

display
optional

The unique displayName of the group

string

type
optional

The unique displayName of the group

string

value
optional

The unique ID of the group

string

3.3. 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.4. GroupMemberMapRequest

Name Schema

origin
optional

string

type
optional

string

value
optional

string

3.5. GroupRequest

Name Schema

description
optional

string

displayName
optional

string

3.6. GroupsResponse

Name Description Schema

itemsPerPage
optional

User Items Per Page

integer (int64)

resources
optional

The list of group objects

< GroupInfo > array

startIndex
optional

Start index of the page

integer (int64)

totalResults
optional

Total group objects

integer (int64)

3.7. HttpErrorResponse

Name Schema

error
optional

Error

path
optional

string

timestamp
optional

string

3.8. HttpUAAErrorResponse

Name Schema

error
optional

string

error_description
optional

string

message
optional

string

timestamp
optional

string

3.9. IdentityProviderInfo

Name Description Schema

active
optional

Identity Provider status
Example : false

boolean

id
optional

The unique ID of the group

string

identityZoneId
optional

Identity Provider identity Zone Id

string

name
optional

Identity Provider name

string

originKey
optional

Identity Provider origin Key

string

type
optional

Type of the Identity Provider

string

version
optional

version of the Identity Provider

string

3.10. Link

Name Schema

href
optional

string

rel
optional

string

templated
optional

boolean

3.11. MemberInfo

Name Description Schema

origin
optional

Origin of the group member

string

type
optional

Type of the member GROUP/USER

string

value
optional

The unique ID of the member

string

3.12. PageMetadata

Name Schema

number
optional

integer (int64)

size
optional

integer (int64)

totalElements
optional

integer (int64)

totalPages
optional

integer (int64)

3.13. PagedUsersListResult

Name Schema

content
optional

< UsersListInfo > array

links
optional

< Link > array

page
optional

PageMetadata

3.14. UserInfo

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

name
optional

The name of the user

UserName

userId
optional

string

userName
optional

The userName/login in of the user

string

3.15. UserInfoWithGroups

Name Description Schema

active
optional

The current status of the user
Example : false

boolean

groups
optional

The list of user related groups

< GroupData > array

id
optional

The unique ID of the user

string

name
optional

The name of the user

UserName

userId
optional

string

userName
optional

The userName/login in of the user

string

3.16. UserName

Name Description Schema

familyName
optional

familyName

string

givenName
optional

givenName

string

3.17. 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://localhost/uaa/oauth/authorize
Token URL : https://localhost/uaa/oauth/token

Name Description

default

Default oauth2 scope.

4.2. resource_owner

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

Name Description

default

Default oauth2 scope.

4.3. implicit_grant

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

Name Description

default

Default oauth2 scope.

4.4. client_creds

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

Name Description

default

Default oauth2 scope.