KDDIクラウドプラットフォームサービス ナレッジサイト

  • HOME
  • 提供API一覧
  • listUsers

listUsers

処理概要

登録されているユーザーアカウントの一覧を取得

 

注意事項

・なし

 

リクエスト

・リクエストパラメータ

Parameter Name Description Required
id List user by ID. false
keyword List by keyword false
username List user by the username false

 

・リクエストサンプル

$ ./kick_api.sh command=listUsers

 

レスポンス

・レスポンスボディ

Name Description
id the user ID
account the account name of the user
accountid the account ID of the user
accounttype the account type of the user
apikey the api key of the user
created the date and time the user account was created
domain the domain name of the user
domainid the domain ID of the user
email the user email address
firstname the user firstname
iscallerchilddomain the boolean value representing if the updating target is in caller’s child domain
isdefault true if user is default, false otherwise
lastname the user lastname
secretkey the secret key of the user
state the user state
timezone the timezone user was created in
username the user name

 

・レスポンスサンプル

【API実行結果】
<listusersresponse cloud-stack-version=”4.3.0.2″>
<count>1</count>
<user>
<id>ec5061f8-7630-40c1-9a5f-210ea0ea7d54</id>
<username>sampleuser1</username>
<firstname>samplefirstname</firstname>
<lastname>samplelastname</lastname>
<email>sample@kddi.com</email>
<created>2016-08-22T22:13:27+0900</created>
<state>enabled</state>
<account>sampleaccount</account>
<accounttype>2</accounttype>
<domainid>e319a46f-faf7-432f-859c-428e5c66341b</domainid>
<domain>M12345678</domain>
<timezone>Asia/Tokyo</timezone>
<apikey>xxxxxxxxm5yw2z9IGCukOMYz1O2Y_Dxi0GNliKJ2JFXpwJeTOzT506oKD2E6XRIBz7o-lZypvelUPx0SU0g</apikey>
<secretkey>xxxxxxxxxWRI6v5-OrswIaCI72CCNFtfwopvM0vYTadY2fVIjatnIcKYo08cO0Mws-iSb188w0eG4Q-9w9Vshw</secretkey>
<accountid>ef1799f4-4d85-467f-b875-50c3d367278b</accountid>
<iscallerchilddomain>false</iscallerchilddomain>
<isdefault>false</isdefault>
</user>
</listusersresponse>

提供API一覧

2022/07/06 2022/07/06