0

0

Favorite/Followers Count

0

SSO Gateway Reference Manual

Docs

7760 / 1

Docs EInnovator Posted 10 Jun 20

SSO Gateway REST API

Signup/Signin/Account

LoginRestController

Method	Path	Query Parameters	Request Body	Response Body	Log	Security	Description
`POST`	/api/register		SsoRegistration		register		Register User
`POST`	/api/change-password			changePassword`POST`			Change User Password
`POST`	/api/resend			resend			Resend Confirmation Email or SMS
`POST`	/api/recover				recover		Get Temporary Login Token
`GET`	/api/login/tmp /api/login-tmp				tmpLogin		Login with Temporary Token
`POST`	/api/logout				logout`POST`		Logout

Users

Method	Path	Query Parameters	Request Body	Response Body	Log	Security	Description
`GET`	/api/user		Page<UserlistUsers UserFilter PageOptions
`GET`	/api/user/{id:.*}/check		checkUser UserOptions
`POST`	/api/user/signature		uploadSig MultipartFile Document
`PUT`	/api/user/avatar/{id:.*}		updateAvatar MultipartFile User
`DELETE`	/api/user/{id:.*}		deleteUser
`POST`	/api/user/confirm		confirm
`GET`	/api/user/{id:.*}		UsergetUser UserOptions
`PUT`	/api/user/{id:.*}		updateUser User
`POST`	/api/user		createUser User
`POST`	/api/user/password		changePassword

Groups

Method	Path	Query Parameters	Request Body	Response Body	Log	Security	Description
`GET`	/api[?/admin]/group /api[?/admin]/organization /api[?/admin]/operation /api[?/admin]/team			count		Long countGroups GroupFilter
`GET`	/api[?/admin]/group /api[?/admin]/organization /api[?/admin]/operation /api[?/admin]/team		Page<Group listGroups PageOptions GroupFilter
`POST`	/api[?/admin]/group /api[?/admin]/organization /api[?/admin]/operation /api[?/admin]/team		createGroup Group RequestOptions
`PUT`	/api[?/admin]/group/ /api[?/admin]/organization/ /api[?/admin]/operation/ /api[?/admin]/team/		updateGroup Group RequestOptions
`DELETE`	/api[?/admin]/group/{gid:.} /api[?/admin]/organization/{gid:.} /api[?/admin]/operation/{gid:.} /api[?/admin]/team/{gid:.}		deleteGroup RequestOptions

Groups Tree (Sub-Groups)

Method	Path	Query Parameters	Request Body	Response Body	Log	Security	Description

Group Membership

Method	Path	Query Parameters	Request Body	Response Body	Log	Security	Description
`DELETE`	/api[?/admin]group/{gid:.}/member /api[?/admin]organization/{gid:.}/member /api[?/admin]operation/{gid:.}/member /api[?/admin]/team/{gid:.}/member		removeMembers[] RequestOptions
`GET`	/api/[?/admin]group//member/ /api/organization//member/ /api/[?/admin]operation//member/ /api/[?/admin]team//member/		Member getGroupMember UserOptions
`POST`	/api/[?/admin]group//member /api[?/admin]/organization//member /api[?/admin]/operation//member /api[?/admin]/team//member		addToGroup Member RequestOptions
`DELETE`	/api/[?/admin]group/{gid:.}/member/{id:.} /api/organization/{gid:.}/member/{id:.} /api/operation/{gid:.}/member/{id:.} /api/team/{gid:.}/member/{id:.}		removeMember RequestOptions
`GET`	/api/group//member /api[?/admin]/organization//member /api[?/admin]/operation//member /api[?/admin]/team//member		Page<Member listMembers PageOptions MemberFilter
`GET`	/api[?/admin]/group/ /api/organization/ /api[?/admin]/operation/ /api[?/admin]/team/		Group getGroup GroupOptions
`GET`	/api/[?/admin]group//member /api[?/admin]/organization//member /api[?/admin]/operation//member /api[?/admin]/team//member	count		Integer countGroupMembers MemberFilter
/api[?/admin]/group/{gid:.}/member /api[?/admin]/organization/{gid:.}/member /api[?/admin]/operation/{gid:.}/member /api[?/admin]/team/{gid:.}/member

Server Management and Info

HomeRestControlller

Method	Path	Query Parameters	Request Body	Response Body	Log	Security	Description
`GET`	/api/ready		ready
`GET`	/api/profiles	`GET`	[] profiles
`GET`	/admin	admin
`GET`	/api/alive		alive
`GET`	/api/principal	user
`GET`	/api/ping			ping

Invitations

Method	Path	Query Parameters	Request Body	Response Body	Log	Security	Description
`PUT`	/api[?/admin]/invitation/ /api[?/admin]/invite/		update Invitation
`GET`	/api[?/admin]/invitation /api/admin/invitation		Page<Invitation list InvitationFilter PageOptions
`DELETE`	/api[?/admin]/invitation/{id:.*}		cancel
`GET`	/api[?/admin]/invitation/{id:.*}		Invitation getInvitation
`DELETE`	/api[?/admin]/invitation /api/admin/invitation		deleteMany[]
`POST`	/api[?/admin]/invitation//resend		Invitation resend
`POST`	/api[?/admin]/invitation//token		makeToken
`POST`	/api[?/admin]/invitation /api/invite /api/admin/invite		invitePost Invitation
`GET`	api[?/admin]/invitation/stats		UserInvitationStats getInvitationStats

Roles

RoleController

Method	Path	Query Parameters	Request Body	Response Body	Log	Security	Description
`GET`	/api[?/admin]/role		Page<Role listRoles PageOptions RoleFilter
`POST`	/api[?/admin]/role		createRole Role
`DELETE`	/api[?/admin]/role		deleteManyRoles[]
`DELETE`	/api[?/admin]/role/{id:.*}		deleteRole
`PUT`	/api[?/admin]/role/{id:.*}		updateRole Role
`GET`	/api[?/admin]/role/{id:.*}		Role getRole

Role Bindings

RoleController

Method	Path	Query Parameters	Request Body	Response Body	Log	Security	Description
`GET`	/api[?/admin]/role/{id:.*}/binding	count		Integer countRoleBindings UserFilter
`DELETE`	/api[?/admin]/role/{id:.}/binding /api/role/{id:.}/user /api/role/{id:.}/unassign / /api/admin/role/{id:.}/user		unassign[]

Clients

Method	Path	Query Parameters	Request Body	Response Body	Log	Security	Description
`GET`	/api/admin/client		Page<Client listClients ClientFilter PageOptions
`POST`	/api/admin/client	`POST`		createClient ClientBoolean
`GET`	/api/admin/client/{id:.*}		Client getClient
`DELETE`	/api/admin/client/{id:.*}		deleteClient
`DELETE`	/api/admin/client		deleteMany[]

Access Tokens

AccessTokenRestController

Method	Path	Query Parameters	Request Body	Response Body	Log	Security	Description
`DELETE`	/api/admin/access_token /api/admin/accesstoken		deleteMany[]
`GET`	/api/admin/access_token /api/admin/accesstoken		Page<OAuthAccessToken listOAuthAccessTokens PageOptions
`GET`	/api/admin/access_token/{id:.} /api/admin/accesstoken/{id:.}		OAuthAccessToken getOAuthAccessToken
`DELETE`	/api/admin/access_token/{id:.} /api/admin/accesstoken/{id:.}		deleteOAuthAccessToken
`POST`	/api/admin/access_token /api/admin/accesstoken		createOAuthAccessToken OAuthAccessTokenBoolean

Refresh Tokens

RefreshTokenRestController

Method	Path	Query Parameters	Request Body	Response Body	Log	Security	Description
`GET`	/api/admin/refresh_token/{id:.} /api/admin/refreshtoken/{id:.}		OAuthRefreshToken getOAuthRefreshToken
`GET`	/api/admin/refresh_token /api/admin/refreshtoken		Page<OAuthRefreshToken listOAuthRefreshTokens PageOptions
`POST`	/api/admin/refresh_token /api/admin/refreshtoken		createOAuthRefreshToken OAuthRefreshTokenBoolean
`DELETE`	/api/admin/refresh_token/{id:.} /api/admin/refreshtoken/{id:.}		deleteOAuthRefreshToken
`DELETE`	/api/admin/refresh_token /api/admin/refreshtoken		deleteMany[]

Other

IdenticonController

Method	Path	Query Parameters	Request Body	Response Body	Log	Security	Description
`GET`	/identicon		identicon				Get synthetic ID Icon
`GET`	/identicon/		identicon				Get synthetic ID Icon

QueryRestController

Method	Path	Query Parameters	Request Body	Response Body	Log	Security	Description
`GET`	/api/query	UserFilter GroupFilter PageOptions		Object[]	query		Polymorphic query

OAuth2 Endpoints

UserInfoControlller

Method	Path	Query Parameters	Request Body	Response Body	Log	Security	Description
`GET`	/ oauth/userinfo			User Details	userinfo		Get Principal Details

OAuth2 workflow endpoints:

Method	Path	Query Parameters	Request Body	Response Body	Log	Security	Description
`POST`	/oauth/authorize
`POST`	/oauth/authorize	user_oauth_approval	approveOrDeny
`POST`	/oauth/token		OAuthAccessToken postAccessToken
`GET`	/oauth/token		OAuthAccessToken getAccessToken
`GET`	/oauth/check_token			? checkToken
`GET`	/oauth/confirm_access getAccessConfirmation
`GET`	/oauth/error handleError
`GET`	/oauth/token_key	getKey

Comments and Discussion

Content