Assignmentの作成
    • PDF

    Assignmentの作成

    • PDF

    記事の要約

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

    Assignmentを作成します。Assignmentは、外部アカウントが使用するポリシーを定義した Permission Setと SSO Userを連携したもので、SSO Userが NAVERクラウドプラットフォームで実行できる権限の範囲を意味します。

    リクエスト

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

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

    リクエストヘッダ

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

    リクエストボディ

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

    フィールドタイプ必須の有無説明
    assignmentNameStringRequiredAssignment名
    • 英数字、記号の「-」、「_」を組み合わせて2~30文字以内で入力
    • 先頭文字は英字または数字のみ使用
    • 作成後は変更不可
    accountMbrNoNumberRequiredアカウントの会員番号(MemberNo)
    permissionSetIdStringRequiredPermission Set ID
    descriptionStringOptionalAssignmentの説明
    • 0~300文字
    consoleAccessAllowedBooleanRequiredコンソールアクセスを許可するかどうか
    • true | false
      • true: 許可
      • false: 許可しない
    apiAccessAllowedBooleanRequiredAPI Gatewayアクセスを許可するかどうか
    • true | false
      • true: 許可
      • false: 許可しない

    リクエスト例

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

    curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/assignments' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
    --data '{
        "assignmentName": "assignment000",
        "accountMbrNo": *******,
        "permissionSetId": "3fcd3c17-****-****-****-2a594248bf28",
        "description": "assignment description",
        "consoleAccessAllowed": true,
        "apiAccessAllowed": true
    }'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    idString-Assignment ID
    successBoolean-API処理結果
    • true | false
      • true: 成功
      • false: 失敗
    messageString-結果メッセージ
    • successfalseの場合、表示

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

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

    レスポンス例

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

    {
        "id": "e1653f17-****-****-****-deb664fb8a2f",
        "success": true
    }
    

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

    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.