Get token exchange profiles

Retrieve a list of all Token Exchange Profiles available in your tenant.

By using this feature, you agree to the applicable Free Trial terms in Okta’s Master Subscription Agreement. It is your responsibility to securely validate the user’s subject_token. See User Guide for more details.

This endpoint supports Checkpoint pagination. To search by checkpoint, use the following parameters:

• from: Optional id from which to start selection.
• take: The total amount of entries to retrieve when using the from parameter. Defaults to 50.

Note: The first time you call this endpoint using checkpoint pagination, omit the from parameter. If there are more results, a next value is included in the response. You can use this for subsequent API calls. When next is no longer included in the response, no pages are remaining.

GET https://{tenantDomain}/api/v2/token-exchange-profiles

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.TokenExchangeProfiles.ListAsync(
            new TokenExchangeProfilesListRequest {
                From = "from",
                Take = 1
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    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>",
        ),
    )
    request := &management.TokenExchangeProfilesListRequest{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
    }
    client.TokenExchangeProfiles.List(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.resources.tokenexchangeprofiles.requests.TokenExchangeProfilesListRequest;

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

        client.tokenExchangeProfiles().list(
            TokenExchangeProfilesListRequest
                .builder()
                .from("from")
                .take(1)
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\TokenExchangeProfiles\Requests\TokenExchangeProfilesListRequest;

$client = new Management(
    token: '<token>',
);
$client->tokenExchangeProfiles->list(
    new TokenExchangeProfilesListRequest([
        'from' => 'from',
        'take' => 1,
    ]),
);

from auth0.management import ManagementClient

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

client.token_exchange_profiles.list(
    from="from",
    take=1,
)

require "auth0"

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

client.token_exchange_profiles.list(
  from: "from",
  take: 1
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.tokenExchangeProfiles.list({
        from: "from",
        take: 1,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.tokenExchangeProfiles.list({
        from: "from",
        take: 1,
    });
}
main();

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

200

{
  "next": "<string>",
  "token_exchange_profiles": [
    {
      "id": "<string>",
      "name": "Token Exchange Profile 1",
      "subject_token_type": "<string>",
      "action_id": "<string>",
      "type": "custom_authentication",
      "created_at": "2024-01-01T00:00:00.000Z",
      "updated_at": "2024-01-01T00:00:00.000Z"
    }
  ]
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de requête

from · string

Optional Id from which to start selection.

take · integer

Number of results per page. Defaults to 50.

Plage requise: 1 <= x <= 100

Réponse

200

application/json

Token Exchange Profile successfully retrieved.

next · string

Opaque identifier for use with the from query parameter for the next page of results.
This identifier is valid for 24 hours.

token_exchange_profiles · object[]

Show child attributes