Get a list of phone providers

Retrieve a list of phone providers details set for a Tenant. A list of fields to include or exclude may also be specified.

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

C#

C#

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

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.ListAsync(
            new ListBrandingPhoneProvidersRequestParameters {
                Disabled = true
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v2/management"
    phone "github.com/auth0/go-auth0/v2/management/branding/phone"
    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
    }
    request := &phone.ListBrandingPhoneProvidersRequestParameters{
        Disabled: management.Bool(
            true,
        ),
    }
    mgmt.Branding.Phone.Providers.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.branding.phone.types.ListBrandingPhoneProvidersRequestParameters;

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

        client.branding().phone().providers().list(
            ListBrandingPhoneProvidersRequestParameters
                .builder()
                .disabled(true)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Branding\Phone\Providers\Requests\ListBrandingPhoneProvidersRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->branding->phone->providers->list(
    new ListBrandingPhoneProvidersRequestParameters([
        'disabled' => true,
    ]),
);

from auth0.management import ManagementClient

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

client.branding.phone.providers.list(
    disabled=True,
)

require "auth0"

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

client.branding.phone.providers.list(disabled: true)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

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

200

{
  "providers": [
    {
      "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"
    }
  ]
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Query Parameters

disabled · boolean

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

Response

200

application/json

Phone providers have been successfully retrieved.

providers · object[]

Show child attributes