API情報#

API一覧#

認証

項番 API名 メソッド URL 説明
1 アクセストークン取得 POST https://auth-api.jp-east-1.paas.cloud.global.fujitsu.com/API/paas/auth/token API認証用のトークンの取得を行う。

利用者管理

項番 API名 メソッド URL 説明
1 ユーザー追加 POST https://k5-apiportal.paas.cloud.global.fujitsu.com/API/v1/api/users 利用者の新規登録を行う。
2 ユーザー変更 PUT https://k5-apiportal.paas.cloud.global.fujitsu.com/API/v1/api/users 契約者および利用者の情報の更新を行う。
3 ユーザーパスワード変更 PUT https://k5-apiportal.paas.cloud.global.fujitsu.com/API/v1/api/userspassword 契約者および利用者のパスワード変更を行う。
4 ユーザー削除 DELETE https://k5-apiportal.paas.cloud.global.fujitsu.com/API/v1/api/users/?login_id={ユーザー名} 利用者の削除を行う。
5 ユーザー認証方式情報更新 PUT https://k5-apiportal.paas.cloud.global.fujitsu.com/API/v1/api/usersauthenticationmethod 契約者および利用者の認証方式を変更する。

各APIの文字コードは「UTF-8」です。

ロール別操作権限について#

FJcloudポータルの各ユーザーには、「ロール」と呼ばれる権限情報が設定され、FJcloudポータルでの操作が制御されます。（詳しくは「FJcloudポータルユーザーズガイド」をご参照ください。）

APIの利用においても、ロールごとに下表に示すとおり権限が設定されています。

API呼び元のロール契約者管理者開発者
API操作対象のロール自分自身利用者自分自身契約者利用者自分自身契約者利用者
ユーザー追加API×○××○×××
ユーザー変更API△○○△○○××
ユーザーパスワード変更API○×○××○××
ユーザー削除API×○××○×××
ユーザー認証方式情報更新API○×○××○××

※利用者：管理者および開発者の両方

○：可能 ×：不可 △：制限付きで可能 （下記[ユーザー変更]の説明を参照）

API名ごとに、実行が許可されているロールを以下に説明します。

[ユーザー追加]

  • 契約者、管理者は契約者以外のロールを持つユーザーを追加可能。

[ユーザー変更]

  • 管理者、開発者は自分自身の情報（パスワード含む）を変更することが可能。
  • 管理者が契約者に対して変更できる情報はパスワードのみ。
  • 契約者は自分自身の情報（ユーザー状態以外）を変更することが可能。
  • 契約者、管理者による利用者（管理者／開発者）の情報更新は可能

[ユーザーパスワード変更]

  • ユーザーはロールに関係なく、自分自身のパスワードのみ変更可能。

[ユーザー削除]

  • 契約者、管理者は契約者以外のロールを持つユーザーを削除可能。

[ユーザー認証方式情報更新]

  • 自分自身の認証方式のみ更新可能

用語集#

用語 説明
ユーザー 機能を利用する人、管理する人。(またはシステム、サービス)
ユーザー名 ユーザーを一意的に識別するための名称。
ロール 人やグループに権限を割り当てるための情報。ロールを用いて、ユーザーが使用できるAPIを区別する。
ロールコード ロールを一意的に識別するためのID。
トークン 認証した証として発行される期限付きの認証情報。