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

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &factors.SetGuardianFactorsProviderPushNotificationSnsRequestContent{}
    client.Guardian.Factors.PushNotification.SetSnsProvider(
        context.TODO(),
        request,
    )
}

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.

Body

application/jsonapplication/x-www-form-urlencoded

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

Response

200

application/json

AWS SNS configuration successfully updated.

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