SSO Userの作成
    • PDF

    SSO Userの作成

    • PDF

    記事の要約

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

    外部アカウントのユーザー情報に基づいて SSO Userを作成します。SSO Userの作成に使用した外部アカウントで NAVERクラウドプラットフォームにログインできます。

    参考

    SSO Userは最大100個まで作成できます。

    リクエスト

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

    メソッドURI
    POST/api/v1/users

    リクエストヘッダ

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

    リクエストボディ

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

    フィールドタイプ必須の有無説明
    loginIdStringRequiredSSO Userログイン ID
    • 3~60文字
    • メール形式
    • 作成後は変更不可
    descriptionStringOptionalSSO Userの説明
    • 0~300文字
    userProfileObjectOptionalSSO User Profile情報
    userProfile.firstNameStringOptionalSSO Userの名(下の名前)
    • 0~200文字
    userProfile.lastNameStringOptionalSSO Userの姓(苗字)
    • 0~200文字
    userProfile.emailStringOptionalSSO Userのメールアドレス
    • 0~200文字
    userProfile.empNoStringOptionalSSO Userの社員番号
    • 0~200文字
    userProfile.phoneCountryCodeStringOptionalSSO Userの国番号
    • 0~10文字
    • 国番号形式
    userProfile.phoneNoStringOptionalSSO Userの携帯電話番号
    • 0~200文字
    • 携帯電話番号形式
    userProfile.deptNameStringOptionalSSO Userの部署名
    • 0~200文字
    accessRulesObjectRequiredアクセスルール情報
    accessRules.consoleAccessAllowedBooleanRequiredコンソールアクセスを許可するかどうか
    • true | false
      • true: 許可
      • false: 許可しない
    accessRules.apiAccessAllowedBooleanRequiredAPI Gatewayアクセスを許可するかどうか
    • true | false
      • true: 許可
      • false: 許可しない

    リクエスト例

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

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

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    userIdString-SSO User ID
    loginIdString-SSO Userログイン ID
    nrnString-SSO Userに対する NAVERクラウドプラットフォームリソースの識別値
    userProfileObject-SSO User Profile情報
    userProfile.firstNameString-SSO Userの名(下の名前)
    userProfile.lastNameString-SSO Userの姓(苗字)
    userProfile.emailString-SSO Userのメールアドレス
    userProfile.emailVerifiedBoolean-メールアドレスは認証済みかどうか
    • true | false
      • true: 認証完了
      • false: 認証が必要
    userProfile.empNoString-SSO Userの社員番号
    userProfile.phoneCountryCodeString-SSO Userの国番号
    userProfile.phoneNoString-SSO Userの携帯電話番号
    userProfile.phoneNoVerifiedBoolean-携帯電話番号は認証済みかどうか
    • true | false
      • true: 認証完了
      • false: 認証が必要
    userProfile.deptNameString-SSO Userの部署名
    accessRulesObject-アクセスルール情報
    accessRules.consoleAccessAllowedBoolean-コンソールアクセスを許可するかどうか
    • true | false
      • true: 許可
      • false: 許可しない
    accessRules.apiAccessAllowedBoolean-API Gatewayアクセスを許可するかどうか
    • true | false
      • true: 許可
      • false: 許可しない
    statusString-SSO Userの状態
    • active | suspended
      • active: 使用中(有効化)
      • suspended: 停止(無効化)
    descriptionString-SSO Userの説明
    lastLoginAtString-SSO Userの最終アクセス日時
    • ISO 8601形式
    createdAtString-SSO Userの作成日時
    • ISO 8601形式
    updatedAtString-SSO Userの更新日時
    • ISO 8601形式

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

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

    レスポンス例

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

    {
        "userId": "8306bedf-****-****-****-40394feacec8",
        "loginId": "******@ncloud.com",
        "nrn": "nrn:PUB:SSO::*******:User/8306bedf-****-****-****-40394feacec8",
        "userProfile": {
            "firstName": "太郎",
            "lastName": "田中",
            "email": "******@ncloud.com",
            "emailVerified": true,
            "empNo": "00112233",
            "phoneCountryCode": "82",
            "phoneNo": "010-0000-0000",
            "phoneNoVerified": true,
            "deptName": "部署"
        },
        "accessRules": {
            "consoleAccessAllowed": true,
            "apiAccessAllowed": true
        },
        "status": "active",
        "createdAt": "2025-01-03T05:04:54Z",
        "updatedAt": "2025-01-03T05:04:54Z",
        "description": "SSO User"
    }
    

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

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.