Saltar al contenido
Developer Docs

Registrar organización cliente

POST
/business/v1/businesses/{businessUuid}/business-collaborators

Crea una organización cliente en estado CREATED, la vincula al colaborador que realiza la llamada (la
organización identificada por el parámetro de ruta y la cabecera de tenant) con el collaboratorType
declarado, y dispara una invitación para cada usuario inicial. El vínculo queda fijado al rol declarado.
El llamante no se convierte en usuario ni administrador de la organización creada.

Reglas de seguridad:

  • La cabecera x-tenant-id debe coincidir con el parámetro de ruta businessUuid.
  • La cabecera x-tenant-id debe coincidir con el claim tenant_id contenido en el token de acceso (JWT).

Autorizaciones

OAuth2ClientCredentials

OAuth2 Client Credentials para acceso máquina a máquina. El token de acceso debe incluir el scope API_INTERNAL (servicio a servicio interno) o API (integraciones M2M externas).

clientCredentials Flow
URL del token"/idp/oauth2/token"
Scopes:
  • "API_INTERNAL"Internal API scope
  • "API"External M2M API scope

Parámetros

Header Parameters

x-tenant-id*

Identificador del tenant que contiene el UUID de la organización

Tipo
string
Requerido
Ejemplo"1f56c928-7621-44fe-8cda-c211fda0a828"
Formato
"uuid"

Path Parameters

businessUuid*

Identificador único de la organización.

Tipo
string
Requerido
Ejemplo"1f56c928-7621-44fe-8cda-c211fda0a828"
Formato
"uuid"

Cuerpo de la petición

application/json
JSON
{
  
"taxId": "7377473W",
  
"type": "COMPANY",
  
"legalName": "My company",
  
"tradeName": "My company trade name",
  
"name": "My name",
  
"lastName": "My last name",
  
"activityCode": "20",
  
"fiscalAddress": {
  
  
"street": "Calle Uría",
  
  
"additionalInformation": "Whatever additional information",
  
  
"postalCode": "33010",
  
  
"cityCode": "ES-AS-OVIEDO",
  
  
"stateCode": "ES-AS",
  
  
"countryCode": "ES"
  
},
  
"collaboratorType": "PARTNER",
  
"users": [
  
  
{
  
  
  
"name": "Jane",
  
  
  
"lastName": "Doe",
  
  
  
"email": "[email protected]",
  
  
  
"role": "ADMINISTRATOR"
  
  
}
  
]
}

Respuestas

Organización registrada; invitaciones disparadas.

application/json
JSON
{
  
"businessUuid": "1f56c928-7621-44fe-8cda-c211fda0a828"
}

Playground

Servidor
Autorización
Headers
Variables
Key
Value
Cuerpo

Ejemplos