CreateAuthConnection

POST

https://api.cbf.tcn.com/api/v0alpha/org/connection/create

CreateAuthConnection creates a new auth0 connection.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Request message for the CreateAuthConnection rpc.

settings

object (AuthConnectionSettings)

settings

optional

ConnectionSettings is the entity for auth 0 connection information.

provider

enum<string>

provider

optional

provider is the type of auth0 connection.
NONE means the org doesn't have a connection setup.

Allowed values:

CONNECTION_TYPE_NONECONNECTION_TYPE_OKTACONNECTION_TYPE_AZURECONNECTION_TYPE_ADFSCONNECTION_TYPE_OIDC

secret_expiration

object (SecretExpiration)

secret_expiration

optional

secret_expiration is an optional field that is
used to know when the connection's secret will
expire. If the connection doesn't have a secret
or the secret will never expire this will be nil.

default_group

object (GroupItem)

default_group

optional

default_group defines settings used for all users for this connection
regardless of their groups. Group name is ignored for the default. This
field can be left nil if no default settings are desired.

issuer_url

string

issuer_url

optional

issuer_url is the url provided by the identity provider
used to get authorization tokens.

tenant_url

string

tenant_url

optional

tenant_url is the url used to match user's emails so
that the connection is used.

client_id

string

client_id

optional

client_id is the id of the application created from
the auth provider.

connection_id

string

connection_id

optional

connection_id is the id of the auth0 connection.
This field will be populated automatically during
the CreateAuthConnection rpc.

custom_groups

array[object (GroupItem) {5}]

custom_groups

optional

custom_groups defines the settings that will be used if a user with
this connection contains one or more of the matching group names.
If a user has multiple matching groups the settings for the highest
priority custom group will be used. Priority is determined by the custom
groups position in the list.

client_secret

string

client_secret

optional

client_secret is an optional field.
some providers require a secret to create a connection.
If the connection uses a secret that expires the
settings.secret_expiration field should be properly
set.
This field is not part of the ConnectionSettings message
because it should never be stored.

Example

{
    "settings": {
        "provider": "CONNECTION_TYPE_NONE",
        "secret_expiration": {
            "date": "1s"
        },
        "default_group": {
            "group_name": "string",
            "agent_profile_group_id": "string",
            "p3_permission_group_id": "string",
            "hunt_group_sid": 0,
            "permission_group_ids": [
                "string"
            ]
        },
        "issuer_url": "string",
        "tenant_url": "string",
        "client_id": "string",
        "connection_id": "string",
        "custom_groups": [
            {
                "group_name": "string",
                "agent_profile_group_id": "string",
                "p3_permission_group_id": "string",
                "hunt_group_sid": 0,
                "permission_group_ids": [
                    "string"
                ]
            }
        ]
    },
    "client_secret": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/org/connection/create' \
--header 'Content-Type: application/json' \
--data-raw '{
    "settings": {
        "provider": "CONNECTION_TYPE_NONE",
        "secret_expiration": {
            "date": "1s"
        },
        "default_group": {
            "group_name": "string",
            "agent_profile_group_id": "string",
            "p3_permission_group_id": "string",
            "hunt_group_sid": 0,
            "permission_group_ids": [
                "string"
            ]
        },
        "issuer_url": "string",
        "tenant_url": "string",
        "client_id": "string",
        "connection_id": "string",
        "custom_groups": [
            {
                "group_name": "string",
                "agent_profile_group_id": "string",
                "p3_permission_group_id": "string",
                "hunt_group_sid": 0,
                "permission_group_ids": [
                    "string"
                ]
            }
        ]
    },
    "client_secret": "string"
}'

Responses

🟢200OK

application/json

Success

Body

object {0}

Example

{}

🔴500Server Error

Modified at 2025-07-10 17:42:28

UpdateP3UserSids

GetAuthConnectionSettings