Create an access ticket to initiate the Self-Service Enterprise Configuration flow

Creates an access ticket to initiate the Self-Service Enterprise Configuration flow using a self-service profile.

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

C#

C#

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

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementClient(
            token: "<token>"
        );

        await client.SelfServiceProfiles.SsoTicket.CreateAsync(
            id: "id",
            request: new CreateSelfServiceProfileSsoTicketRequestContent()
        );
    }

}

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &selfserviceprofiles.CreateSelfServiceProfileSsoTicketRequestContent{}
    client.SelfServiceProfiles.SsoTicket.Create(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.resources.selfserviceprofiles.ssoticket.requests.CreateSelfServiceProfileSsoTicketRequestContent;

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

        client.selfServiceProfiles().ssoTicket().create(
            "id",
            CreateSelfServiceProfileSsoTicketRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\SelfServiceProfiles\SsoTicket\Requests\CreateSelfServiceProfileSsoTicketRequestContent;

$client = new Management(
    token: '<token>',
);
$client->selfServiceProfiles->ssoTicket->create(
    'id',
    new CreateSelfServiceProfileSsoTicketRequestContent([]),
);

from auth0.management import ManagementClient

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

client.self_service_profiles.sso_ticket.create(
    id="id",
)

require "auth0"

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

client.self_service_profiles.sso_ticket.create(id: "id")

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

curl --request POST \
  --url https://{tenantDomain}/api/v2/self-service-profiles/{id}/sso-ticket \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection_id": "<string>",
  "enabled_clients": [
    "<string>"
  ],
  "enabled_organizations": [
    {
      "organization_id": "<string>",
      "assign_membership_on_login": true,
      "show_as_button": true
    }
  ],
  "ttl_sec": 216000,
  "provisioning_config": {
    "scopes": [],
    "token_lifetime": 901
  },
  "use_for_organization_discovery": true,
  "enabled_features": {
    "sso": true,
    "domain_verification": true,
    "provisioning": true
  }
}
'

201

{
  "ticket": "<string>"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Headers

auth0-custom-domain · string

Custom domain to be used for this request

Required string length: 3 - 255

Path Parameters

id · string · required

The id of the self-service profile to retrieve

Body

application/jsonapplication/x-www-form-urlencoded

connection_id · string<connection-id>

If provided, this will allow editing of the provided connection during the Self-Service Enterprise Configuration flow

connection_config · object

If provided, this will create a new connection for the Self-Service Enterprise Configuration flow with the given configuration

Show child attributes

enabled_clients · string[]

List of client_ids that the connection will be enabled for.

enabled_organizations · object[]

List of organizations that the connection will be enabled for.

Show child attributes

ttl_sec · integer

Number of seconds for which the ticket is valid before expiration. If unspecified or set to 0, this value defaults to 432000 seconds (5 days).

Required range: 0 <= x <= 432000

domain_aliases_config · object

Configuration for the setup of the connection’s domain_aliases in the Self-Service Enterprise Configuration flow.

Show child attributes

provisioning_config · object · GA

Configuration for the setup of Provisioning in the self-service flow.

Show child attributes

use_for_organization_discovery · boolean · GA

Indicates whether a verified domain should be used for organization discovery during authentication.

enabled_features · object · GA

Specifies which features are enabled for an "edit connection" ticket. Only applicable when connection ID is provided.

Show child attributes

Response

201

application/json

Self-Service Enterprise Configuration Access Ticket successfully created.

ticket · string

The URL for the created ticket.