Get a phone provider

Retrieve phone provider details. A list of fields to include or exclude may also be specified.

GET https://{tenantDomain}/api/v2/branding/phone/providers/{id}

C#

C#

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

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.Branding.Phone.Providers.GetAsync(
            "id"
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    mgmt.Branding.Phone.Providers.Get(
        context.TODO(),
        "id",
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;

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

        client.branding().phone().providers().get("id");
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->branding->phone->providers->get(
    'id',
);

from auth0.management import ManagementClient

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

client.branding.phone.providers.get(
    id="id",
)

require "auth0"

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

client.branding.phone.providers.get(id: "id")

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.branding.phone.providers.get("id");
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.branding.phone.providers.get("id");
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/branding/phone/providers/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "tenant": "<string>",
  "channel": "phone",
  "disabled": true,
  "configuration": {
    "sid": "<string>",
    "delivery_methods": [],
    "default_from": "<string>",
    "mssid": "<string>"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

Required string length: 1 - 255

レスポンス

200

application/json

Phone provider successfully retrieved.

Phone provider configuration schema

name · enum<string> · 必須

Name of the phone notification provider

利用可能なオプション: twilio, custom

Required string length: 1 - 100

id · string

Required string length: 1 - 255

tenant · string

The name of the tenant

Required string length: 1 - 255

channel · enum<string>

This depicts the type of notifications this provider can receive.

利用可能なオプション: phone

Maximum string length: 100

disabled · boolean

Whether the provider is enabled (false) or disabled (true).

configuration · object

Option 1

Option 2

Show child attributes

created_at · string<date-time>

The provider's creation date and time in ISO 8601 format

Maximum string length: 27

updated_at · string<date-time>

The date and time of the last update to the provider in ISO 8601 format

Maximum string length: 27