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

Go

Go

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,
    )
}

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
  }
}
'

import requests

url = "https://{tenantDomain}/api/v2/self-service-profiles/{id}/sso-ticket"

payload = {
    "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
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/self-service-profiles/{id}/sso-ticket",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/self-service-profiles/{id}/sso-ticket")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"connection_id\": \"<string>\",\n  \"enabled_clients\": [\n    \"<string>\"\n  ],\n  \"enabled_organizations\": [\n    {\n      \"organization_id\": \"<string>\",\n      \"assign_membership_on_login\": true,\n      \"show_as_button\": true\n    }\n  ],\n  \"ttl_sec\": 216000,\n  \"provisioning_config\": {\n    \"scopes\": [],\n    \"token_lifetime\": 901\n  },\n  \"use_for_organization_discovery\": true,\n  \"enabled_features\": {\n    \"sso\": true,\n    \"domain_verification\": true,\n    \"provisioning\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/self-service-profiles/{id}/sso-ticket")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"connection_id\": \"<string>\",\n  \"enabled_clients\": [\n    \"<string>\"\n  ],\n  \"enabled_organizations\": [\n    {\n      \"organization_id\": \"<string>\",\n      \"assign_membership_on_login\": true,\n      \"show_as_button\": true\n    }\n  ],\n  \"ttl_sec\": 216000,\n  \"provisioning_config\": {\n    \"scopes\": [],\n    \"token_lifetime\": 901\n  },\n  \"use_for_organization_discovery\": true,\n  \"enabled_features\": {\n    \"sso\": true,\n    \"domain_verification\": true,\n    \"provisioning\": true\n  }\n}"

response = http.request(request)
puts response.read_body

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.