Configure AWS SNS configuration

Configure the AWS SNS push notification provider configuration (subscription required).

PUT https://{tenantDomain}/api/v2/guardian/factors/push-notification/providers/sns

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Guardian.Factors;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Guardian.Factors.PushNotification.SetSnsProviderAsync(
            new SetGuardianFactorsProviderPushNotificationSnsRequestContent()
        );
    }

}

package example

import (
    context "context"

    client "github.com/auth0/go-auth0/v2/management/client"
    factors "github.com/auth0/go-auth0/v2/management/guardian/factors"
    option "github.com/auth0/go-auth0/v2/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &factors.SetGuardianFactorsProviderPushNotificationSnsRequestContent{}
    mgmt.Guardian.Factors.PushNotification.SetSnsProvider(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.guardian.factors.types.SetGuardianFactorsProviderPushNotificationSnsRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.guardian().factors().pushNotification().setSnsProvider(
            SetGuardianFactorsProviderPushNotificationSnsRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Guardian\Factors\PushNotification\Requests\SetGuardianFactorsProviderPushNotificationSnsRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->guardian->factors->pushNotification->setSnsProvider(
    new SetGuardianFactorsProviderPushNotificationSnsRequestContent([]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.guardian.factors.push_notification.set_sns_provider()

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.guardian.factors.push_notification.set_sns_provider

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.guardian.factors.pushNotification.setSnsProvider({});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.guardian.factors.pushNotification.setSnsProvider({});
}
main();

curl --request PUT \
  --url https://{tenantDomain}/api/v2/guardian/factors/push-notification/providers/sns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "aws_access_key_id": "wywA2BH4VqTpfywiDuyDAYZL3xQjoO40",
  "aws_secret_access_key": "B1ER5JHDGJL3C4sVAKK7SBsq806R3IpL",
  "aws_region": "us-west-1",
  "sns_apns_platform_application_arn": "<string>",
  "sns_gcm_platform_application_arn": "urn://yRMeBxgcCXh8MeTXPBAxhQnm6gP6f5nP"
}
'

200

{
  "aws_access_key_id": "wywA2BH4VqTpfywiDuyDAYZL3xQjoO40",
  "aws_secret_access_key": "B1ER5JHDGJL3C4sVAKK7SBsq806R3IpL",
  "aws_region": "us-west-1",
  "sns_apns_platform_application_arn": "<string>",
  "sns_gcm_platform_application_arn": "urn://yRMeBxgcCXh8MeTXPBAxhQnm6gP6f5nP"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

ボディ

application/jsonapplication/x-www-form-urlencoded

aws_access_key_id · string | null · デフォルト: wywA2BH4VqTpfywiDuyDAYZL3xQjoO40

Required string length: 1 - 1000

aws_secret_access_key · string | null · デフォルト: B1ER5JHDGJL3C4sVAKK7SBsq806R3IpL

Required string length: 1 - 1000

aws_region · string | null · デフォルト: us-west-1

Required string length: 1 - 1000

Pattern: ^(?:us-east-[0-9]{1,2}|us-west-[0-9]{1,2}|ap-southeast-[0-9]{1,2}|ap-northeast-[0-9]{1,2}|ap-central-[0-9]{1,2}|eu-west-[0-9]{1,2}|eu-central-[0-9]{1,2})$

sns_apns_platform_application_arn · string | null

Required string length: 1 - 1000

sns_gcm_platform_application_arn · string | null · デフォルト: urn://yRMeBxgcCXh8MeTXPBAxhQnm6gP6f5nP

Required string length: 1 - 1000

レスポンス

200

application/json

AWS SNS configuration successfully updated.

aws_access_key_id · string | null · デフォルト: wywA2BH4VqTpfywiDuyDAYZL3xQjoO40

Required string length: 1 - 1000

aws_secret_access_key · string | null · デフォルト: B1ER5JHDGJL3C4sVAKK7SBsq806R3IpL

Required string length: 1 - 1000

aws_region · string | null · デフォルト: us-west-1

Required string length: 1 - 1000

Pattern: ^(?:us-east-[0-9]{1,2}|us-west-[0-9]{1,2}|ap-southeast-[0-9]{1,2}|ap-northeast-[0-9]{1,2}|ap-central-[0-9]{1,2}|eu-west-[0-9]{1,2}|eu-central-[0-9]{1,2})$

sns_apns_platform_application_arn · string | null

Required string length: 1 - 1000

sns_gcm_platform_application_arn · string | null · デフォルト: urn://yRMeBxgcCXh8MeTXPBAxhQnm6gP6f5nP

Required string length: 1 - 1000