SSO Userの更新

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

Classic/VPC環境で利用できます。

SSO User情報を更新します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
PUT	/api/v1/users/{userId}

リクエストヘッダ

Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`userId`	String	Required	SSO User ID SSO Userリストの照会を参照

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`description`	String	Optional	SSO Userの説明 0~300文字
`userProfile`	Object	Optional	SSO User Profile情報
`userProfile.firstName`	String	Optional	SSO Userの名(下の名前) 0~200文字
`userProfile.lastName`	String	Optional	SSO Userの姓(苗字) 0~200文字
`userProfile.email`	String	Optional	SSO Userのメールアドレス 0~200文字
`userProfile.empNo`	String	Optional	SSO Userの社員番号 0~200文字
`userProfile.phoneCountryCode`	String	Optional	SSO Userの国番号 0~10文字国番号形式
`userProfile.phoneNo`	String	Optional	SSO Userの携帯電話番号 0~200文字携帯電話番号形式
`userProfile.deptName`	String	Optional	SSO Userの部署名 0~200文字
`accessRules`	Object	Required	アクセスルール情報
`accessRules.consoleAccessAllowed`	Boolean	Required	コンソールアクセスを許可するかどうか `true` \| `false` `true`: 許可 `false`: 許可しない
`accessRules.apiAccessAllowed`	Boolean	Required	API Gatewayアクセスを許可するかどうか `true` \| `false` `true`: 許可 `false`: 許可しない

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request PUT 'https://sso.apigw.ntruss.com/api/v1/users/8306bedf-****-****-****-40394feacec8' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "description": "SSO User",
    "userProfile": {
        "firstName": "太郎",
        "lastName": "田中",
        "email": "******@ncloud.com",
        "empNo": "00112233",
        "phoneCountryCode": "82",
        "phoneNo": "010-1111-1111",
        "deptName": "部署"
    },
    "accessRules": {
        "consoleAccessAllowed": true,
        "apiAccessAllowed": true
    }
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`id`	String	-	SSO User ID
`nrn`	String	-	SSO Userに対する NAVERクラウドプラットフォームリソースの識別値
`success`	Boolean	-	API処理結果 `true` \| `false` `true`: 成功 `false`: 失敗
`message`	String	-	結果メッセージ `success`が`false`の場合、表示

レスポンスステータスコード

Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "id": "80d9ba0d-****-****-****-76afe6ea5b33",
    "nrn": "nrn:PUB:SSO::*******:User/80d9ba0d-****-****-****-76afe6ea5b33",
    "success": true
}

この記事は役に立ちましたか?

What's Next

SSO Userリストの削除

リクエスト
レスポンス