Loading...

Aviso:

Para brindarle información de soporte completa de manera más rápida, el contenido de esta página ha sido traducido al español mediante traducción automática. Para consultar la información de soporte más precisa, consulte la versión en inglés de este contenido.

Authentication

Las funcionalidades de Catalyst Authentication te permiten agregar usuarios finales a tus aplicaciones serverless de Catalyst, configurar sus cuentas de usuario y roles, y gestionar el inicio de sesión y la autenticación de usuarios de tu aplicación.

Agregar un nuevo usuario

Descripción

Esta API te permite agregar un nuevo usuario final a la aplicación de Catalyst para una plataforma específica. Cuando el usuario se ha registrado, se crean valores de identificación únicos como ZUID, userID para él.

Nota: Solo podrás agregar 25 usuarios en tu aplicación en el entorno de desarrollo. Después de desplegar tu aplicación a producción, puedes incluir cualquier cantidad de usuarios finales en ella.

Detalles de la solicitud

URL de la solicitud

POST

{api-domain}/baas/v1/project/{project_id}/project-user/signup

copy

api-domain
URL
El dominio específico del DC para acceder a Catalyst API

project_id
Numerical
El ID único del proyecto

Encabezados de la solicitud

Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json

Encabezados opcionales

CATALYST-ORG: {org_id}

Environment: Development

Scope

ZohoCatalyst.projects.users.CREATE


Propiedades JSON de la solicitud

platform_type string
mandatory
Valores aceptados: web, android, ios
redirect_url string
optional
La URL a la que se redirigirá después de que el usuario se registre en la aplicación
Tamaño máximo: 200
user_details json
mandatory

El JSON que contiene los detalles del usuario

first_name string
mandatory
Nombre del usuario
Tamaño máximo: 100

last_name string
optional
Apellido del usuario
Tamaño máximo: 100

email_id string
mandatory
Dirección de correo electrónico del usuario

Detalles de la respuesta

La respuesta contendrá los detalles del usuario agregado en la clave data, incluyendo los metadatos y valores de identificación como zaid, user_id y org_id que fueron generados.

Sample Request
copy

curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/3000000002001/project-user/signup
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-H “PROJECT_ID: 1010309726”
-d ‘{ “user_details”:{ “first_name”:“Rowena”, “last_name”:“Simmons”, “email_id”:“r.simmons@zylker.com” }, “platform_type”:“web”, “redirect_url”:“https://logistics.zylker.com/app/index.html" }’

Sample Response
copy
{
    "status": "success",
    "data": {
        "zaid": 1010309726,
        "user_details": {
            "user_id": 671930455,
            "user_type": "App Administrator",
            "zuid": 3000000006001,
            "zaaid": 1011520995,
            "status": "ACTIVE",
            "is_confirmed": true,
            "email_id": "r.simmons@zylker.com",
            "first_name": "Rowena",
            "last_name": "Simmons",
            "created_time": "May 13, 2019 09:16 PM",
            "modified_time": "May 13, 2019 09:16 PM",
            "invited_time": "May 13, 2019 09:16 PM",
            "role_details": {
                "role_id": 1256000000288012,
                "role_name": "App Administrator"
            }
        },
        "redirect_url": "https://logistics.zylker.com/app/index.html",
        "platform_type": "web",
        "org_id": 1011520995
        "locale": "us|en_us|America/Los_Angeles"
        "time_zone": "America/Los_Angeles"
    }
}