Get AWS SNS configuration

Retrieve configuration details for an AWS SNS push notification provider that has been enabled for MFA. To learn more, review Configure Push Notifications for MFA.

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

C#

C#

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

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementClient(
            token: "<token>"
        );

        await client.Guardian.Factors.PushNotification.GetSnsProviderAsync();
    }

}

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    client.Guardian.Factors.PushNotification.GetSnsProvider(
        context.TODO(),
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;

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

        client.guardian().factors().pushNotification().getSnsProvider();
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;

$client = new Management(
    token: '<token>',
);
$client->guardian->factors->pushNotification->getSnsProvider();

from auth0.management import ManagementClient

client = ManagementClient(
    token="<token>",
)

client.guardian.factors.push_notification.get_sns_provider()

require "auth0"

client = Auth0::Management.new(token: "<token>")

client.guardian.factors.push_notification.get_sns_provider

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

curl --request GET \
  --url https://{tenantDomain}/api/v2/guardian/factors/push-notification/providers/sns \
  --header 'Authorization: Bearer <token>'

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"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Response

200

application/json

AWS SNS configuration successfully retrieved.

aws_access_key_id · string | null · default: wywA2BH4VqTpfywiDuyDAYZL3xQjoO40

Required string length: 1 - 1000

aws_secret_access_key · string | null · default: B1ER5JHDGJL3C4sVAKK7SBsq806R3IpL

Required string length: 1 - 1000

aws_region · string | null · default: 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 · default: urn://yRMeBxgcCXh8MeTXPBAxhQnm6gP6f5nP

Required string length: 1 - 1000