Revoke a Self-Service Enterprise Configuration access ticket

Revokes a Self-Service Enterprise Configuration access ticket and invalidates associated sessions. The ticket will no longer be accepted to initiate a Self-Service Enterprise Configuration session. If any users have already started a session through this ticket, their session will be terminated. Clients should expect a 202 Accepted response upon successful processing, indicating that the request has been acknowledged and that the revocation is underway but may not be fully completed at the time of response. If the specified ticket does not exist, a 202 Accepted response is also returned, signaling that no further action is required. Clients should treat these 202 responses as an acknowledgment that the request has been accepted and is in progress, even if the ticket was not found.

POST https://{tenantDomain}/api/v2/self-service-profiles/{profileId}/sso-ticket/{id}/revoke

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.SelfServiceProfiles.SsoTicket.RevokeAsync(
            "profileId",
            "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.SelfServiceProfiles.SsoTicket.Revoke(
        context.TODO(),
        "profileId",
        "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.selfServiceProfiles().ssoTicket().revoke("profileId", "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->selfServiceProfiles->ssoTicket->revoke(
    'profileId',
    'id',
);

from auth0.management import ManagementClient

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

client.self_service_profiles.sso_ticket.revoke(
    profile_id="profileId",
    id="id",
)

require "auth0"

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

client.self_service_profiles.sso_ticket.revoke(
  profile_id: "profileId",
  id: "id"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.selfServiceProfiles.ssoTicket.revoke("profileId", "id");
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.selfServiceProfiles.ssoTicket.revoke("profileId", "id");
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/self-service-profiles/{profileId}/sso-ticket/{id}/revoke \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

profileId · string · required

The id of the self-service profile

id · string · required

The id of the ticket to revoke

Response

202

Self-Service Enterprise Configuration Access Ticket revocation request accepted.