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.

Obtener los detalles de todos los usuarios

Descripción

Esta API te permite obtener los detalles de todos los usuarios de las aplicaciones de Catalyst de una aplicación en particular a través de paginación. La paginación te permite recuperar la lista de usuarios en páginas mediante una iteración de llamadas a la API.

Por ejemplo, si necesitas que los registros de usuarios se obtengan en lotes de 200 como páginas individuales, debes incluir un parámetro start y un parámetro end en tu solicitud. Puedes establecer el índice de inicio en 0 usando el parámetro start, y especificar el número máximo de usuarios a obtener como 200 usando el parámetro end. Para obtener el siguiente conjunto de registros de usuarios, puedes ejecutar otra llamada a la API estableciendo el índice start en 200, y especificando el número de registros de usuarios en esa página usando el parámetro end de manera correspondiente.

Detalles de la solicitud

URL de la solicitud

GET

{api-domain}/baas/v1/project/{project_id}/project-user?start={start_index}&end={number_of_users}

copy

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

project_id
Numerical
El ID único del proyecto

start
Numerical

El índice de inicio desde el cual obtener los registros de usuarios


end
Numerical

Número de registros de usuarios a devolver en una sola página mediante paginación


Encabezados de la solicitud

Authorization: Zoho-oauthtoken {oauth_token}

Encabezados opcionales

CATALYST-ORG: {org_id}

Environment: Development

Scope

ZohoCatalyst.projects.users.READ

Detalles de la respuesta

La respuesta contendrá los detalles de todos los usuarios de la aplicación, incluyendo sus valores de identificación como zuid, user_id, email_id y los detalles de su rol.

Sample Request
copy

curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/3000000005007/project-user?start=100&end=3
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”

Sample Response
copy
{
    "status": "success",
    "data": [
        {
            "zuid": 3171930121,
            "zaaid": 1019540153,
            "status": "ACTIVE",
            "user_id": 671930409,
            "user_type": "App User",
            "is_confirmed": true,
            "email_id": "ron.grisham@zylker.com",
            "first_name": "Ronald",
            "last_name": "Grisham",
            "created_time": "Jul 09, 2019 04:11 PM",
            "modified_time": "Jul 09, 2019 04:11 PM",
            "invited_time": "Jul 09, 2019 04:11 PM",
            "role_details": {
                "role_id": 3000000005015,
                "role_name": "App User"
            }
            "org_id":1019540153
            "locale": "us|en_us|America/Los_Angeles"
            "time_zone": "America/Los_Angeles"
        },
        {
            "zuid": 3171930089,
            "zaaid": 1019543293,
            "status": "ACTIVE",
            "user_id": 671930121,
            "user_type": "App User",
            "is_confirmed": true,
            "email_id": "Lucy.p@zylker.com",
            "first_name": "Lucy",
            "last_name": "Pettigrew",
            "created_time": "Jul 09, 2019 04:26 PM",
            "modified_time": "Jul 09, 2019 04:26 PM",
            "invited_time": "Jul 09, 2019 04:26 PM",
            "role_details": {
                "role_id": 3000000005015,
                "role_name": "App User"
            }
            "org_id":1019540153
            "locale": "us|en_us|America/Los_Angeles"
            "time_zone": "America/Los_Angeles"
        },
        {
            "zuid": 3171937685,
            "zaaid": 1019540091,
            "status": "ACTIVE",
            "user_id": 671930888,
            "user_type": "App User",
            "is_confirmed": true,
            "email_id": "zayn.ahmed@zylker.com",
            "first_name": "Zayn",
            "last_name": "Ahmed",
            "created_time": "Jul 09, 2019 04:26 PM",
            "modified_time": "Jul 09, 2019 04:26 PM",
            "invited_time": "Jul 09, 2019 04:26 PM",
            "role_details": {
                "role_id": 3000000005015,
                "role_name": "App User"
            }
            "org_id":1019540153
            "locale": "us|en_us|America/Los_Angeles"
            "time_zone": "America/Los_Angeles"
        }
    ]
}
View more