Assignmentにターゲットを追加
    • PDF

    Assignmentにターゲットを追加

    • PDF

    記事の要約

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

    Assignmentにターゲット(SSO User、グループ)を追加します。

    リクエスト

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

    メソッドURI
    POST/api/v1/assignments/{assignmentId}/targets

    リクエストヘッダ

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

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

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

    フィールドタイプ必須の有無説明
    assignmentIdStringRequiredAssignment ID

    リクエストボディ

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

    フィールドタイプ必須の有無説明
    targetTypeStringRequiredターゲットのタイプ
    • user | group
      • user: SSO User
      • group: グループ
    targetIdsArrayRequiredターゲット ID

    リクエスト例

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

    curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/assignments/2c15b16c-****-****-****-3e7207ff2bf6/targets' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
    --data '{
        "targetType": "group",
        "targetIds": [
            "12cfbd94-****-****-****-2ff725201395"
        ]
    }'
    

    レスポンス

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

    レスポンスボディ

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

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

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

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

    レスポンス例

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

    {
        "id": "2c15b16c-****-****-****-3e7207ff2bf6",
        "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.