Crear perfiles de conexión

Crear un perfil de conexión.

POST https://{tenantDomain}/api/v2/connection-profiles

Crear un perfil de conexión

cURL

curl --request POST \
  --url https://{tenantDomain}/api/v2/connection-profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "connection_config": {},
  "connection_name_prefix_template": "<string>",
  "enabled_features": [],
  "organization": {},
  "strategy_overrides": {
    "ad": {
      "connection_config": {},
      "enabled_features": []
    },
    "adfs": {
      "connection_config": {},
      "enabled_features": []
    },
    "google-apps": {
      "connection_config": {},
      "enabled_features": []
    },
    "oidc": {
      "connection_config": {},
      "enabled_features": []
    },
    "okta": {
      "connection_config": {},
      "enabled_features": []
    },
    "pingfederate": {
      "connection_config": {},
      "enabled_features": []
    },
    "samlp": {
      "connection_config": {},
      "enabled_features": []
    },
    "waad": {
      "connection_config": {},
      "enabled_features": []
    }
  }
}
'

201

{
  "connection_config": {},
  "connection_name_prefix_template": "<string>",
  "enabled_features": [],
  "id": "<string>",
  "name": "<string>",
  "organization": {},
  "strategy_overrides": {
    "ad": {
      "connection_config": {},
      "enabled_features": []
    },
    "adfs": {
      "connection_config": {},
      "enabled_features": []
    },
    "google-apps": {
      "connection_config": {},
      "enabled_features": []
    },
    "oidc": {
      "connection_config": {},
      "enabled_features": []
    },
    "okta": {
      "connection_config": {},
      "enabled_features": []
    },
    "pingfederate": {
      "connection_config": {},
      "enabled_features": []
    },
    "samlp": {
      "connection_config": {},
      "enabled_features": []
    },
    "waad": {
      "connection_config": {},
      "enabled_features": []
    }
  }
}

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Cuerpo

application/jsonapplication/x-www-form-urlencoded

name · string · requerido

El nombre del perfil de conexión.

Required string length: 1 - 50

connection_config · object

Configuración del perfil de conexión.

connection_name_prefix_template · string

Plantilla de prefijo del nombre de la conexión.

Maximum string length: 15

Pattern: ^(?!-)(?!.*--)(?:[a-zA-Z0-9-]|{org_id}|{org_name})*$

enabled_features · enum<string>[]

Funciones habilitadas para el perfil de conexión.

Enumeración de funciones habilitadas.

Opciones disponibles: scim, universal_logout

organization · object

La organización del perfil de conexión.

Show child attributes

strategy_overrides · object

Sobrescrituras específicas de la estrategia para este atributo

Show child attributes

Respuesta

201

application/json

Perfil de conexión creado correctamente.

connection_config · object

Configuración del perfil de conexión.

connection_name_prefix_template · string

Plantilla de prefijo del nombre de la conexión.

Maximum string length: 15

Pattern: ^(?!-)(?!.*--)(?:[a-zA-Z0-9-]|{org_id}|{org_name})*$

enabled_features · enum<string>[]

Funciones habilitadas para el perfil de conexión.

Enumeración de funciones habilitadas.

Opciones disponibles: scim, universal_logout

id · string<connection-profile-id>

Identificador del perfil de conexión.

name · string

El nombre del perfil de conexión.

Required string length: 1 - 50

organization · object

La organización del perfil de conexión.

Show child attributes

strategy_overrides · object

Sobrescrituras específicas de la estrategia para este atributo

Show child attributes