1. API Outline

1.1 List of API

No.	API Group	API	Method	URL	Description
1	Authentication	Get access token	POST	https://auth-api.jp-east-1.paas.cloud.global.fujitsu.com/API/paas/auth/token	Get token for API authentication.
2	User management	Create user	POST	https://k5-apiportal.paas.cloud.global.fujitsu.com/API/v1/api/users	Create a new user.
3		Change user information	PUT	https://k5-apiportal.paas.cloud.global.fujitsu.com/API/v1/api/users	Change information of　the contractor or the specified user.
4		Change user password	PUT	https://k5-apiportal.paas.cloud.global.fujitsu.com/API/v1/api/userspassword	Change password of the specified user.
5		Delete user	DELETE	https://k5-apiportal.paas.cloud.global.fujitsu.com/API/v1/api/users/?login_id={UserName}	Delete the specified user.
6		Update user authentication information	PUT	https://k5-apiportal.paas.cloud.global.fujitsu.com/API/v1/api/usersauthenticationmethod	Update user authentication method of the contractor or a user.

API character encoding is UTF-8.

1.2 Access Rights by Role

Each user of the FJCS Portal is assigned a ‘Role’ that controls the operations the user is authorized to perform on the FJCS Portal. (Refer to the 'FJCS Portal User Guide' for detail.)

Also for the use of APIs, access rights are assigned by role as shown below.

Caller role	Contractor		Administrator			Developer
Role of Operation Target	Oneself	USER	Oneself	Contractor	USER	Oneself	Contractor	USER
Create New User	×	○	×	×	○	×	×	×
Change User Infomation	△	○	○	△	○	○	×	×
Change User Password	○	×	○	×	×	○	×	×
Delete User	×	○	×	×	○	×	×	×
Update User Authentication Infomation	○	×	○	×	×	○	×	×

○: Permitted ×: Not Permitted 　△:Permitted with restrictions (See [Change user information ] below.)

By API name, the roles to which the executions are permitted are shown below.

[Create New User]
- The Contractor and Administrator can create a user except with the role of Contractor.

[Change user information]
- The Administrator and Developer can change the information of one’s own, including password.
- The information of the Contractor which can be changed by an Administrator is only its password.
- The Contractor can change his/her own information, except its user status.
- The Contractor and Administrator can change the information of USERs (Administrator / Developer ).

[Change user password]
- Regardless of role, a user can change one’s own password.

[Delete user]
- The Contractor and Administrator can delete a user with a role except Contractor.

[Update user authentication information]
- All users can update his/her own user authentication method.

1.3 Glossary

Term	Explanation
User	Person (or system, service) who uses or manages a function
User name	Unique ID of a user
Role	Authorization granted to a person or a group. Role of a user determines which API that user can execute.
Role code	Unique ID of a role