Profiles

Overview

In Bigin, profiles define user permissions and control the actions the user performs within the application. Each user in the Bigin setup is assigned a profile that determines their level of access to the data in the organization. By default, Administrator and Standard profiles are available in the organization. Bigin enables users to create custom profiles as well.

Endpoints

GET /settings/profiles

Get all profiles data

Retrieves the list of available profiles and their properties in an organization.

Request URL

{api-domain}/bigin/v2/settings/profiles

Choose domain-specific URL to replace {api-domain}

You can use the domain-specific URL to access Bigin resources. Based on the data center in which the Bigin account's resources are available, replace {api-domain} in the preceding request with one of the following API domain URLs:

For US, https://www.zohoapis.com
For EU, https://www.zohoapis.eu
For AU, https://www.zohoapis.com.au
For IN, https://www.zohoapis.in
For CN, https://www.zohoapis.com.cn
For JP, https://www.zohoapis.jp

For more information, see Multi DC Support.

Authorization

For this endpoint, pass the access token as an authorization header. See OAuth Authentication for more information about access tokens.

Authorization: Zoho-oauthtoken <ACCESS_TOKEN>

You must authenticate using an access token that is associated with one of the following scopes:

ZohoBigin.settings.profiles.ALL
ZohoBigin.settings.profiles.READ

Request parameters

The request parameters aren't available for this endpoint.

Sample request

Curl Deluge

Copiedcurl "https://www.zohoapis.com/bigin/v2/settings/profiles" \
-X GET \
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Copiedresponse = invokeurl
[
	url: "https://www.zohoapis.com/bigin/v2/settings/profiles"
	type: GET
	connection:"connection_link_name"
];
info response;

Response object

The response object contains the following details:

display_label string

The display label of the profile. For example, Administrator or Standard.

created_time datetime

Indicates the date and time (ISO8601) at which the current profile is created.

modified_time datetime

Indicates the date and time (ISO8601) of the most recent modifications performed in profile properties.

custom boolean

Has the value true if the profile is created manually or the value false if the profile exists by default.

name string

The name of the profile.

modified_by jsonobject

The JSON object contains the user details who have performed the most recent modifications of the profile properties.

description string

Indicates the description of the profile.

id string

The unique identifier of the profile.

type string

Indicates the type of the profile.

created_by jsonobject

The unique identifier of the role.

Possible error codes

The response of this resource includes HTTP status and error codes.

Sample response

Copied{
    "profiles": [
        {
            "display_label": "Administrator",
            "created_time": null,
            "modified_time": null,
            "custom": false,
            "name": "Administrator",
            "modified_by": null,
            "description": "This profile will have all the permissions. Users with Administrator profile will be able to view and manage all the data within the organization account by default.",
            "id": "2034020000000015972",
            "type": "normal_profile",
            "created_by": null
        },
        {
            "display_label": "Standard",
            "created_time": null,
            "modified_time": "2023-07-05T19:50:06+05:30",
            "custom": false,
            "name": "Standard",
            "modified_by": {
                "name": "Zylker Travels",
                "id": "2034020000000457001"
            },
            "description": "This profile will have all the permissions except administrative privileges.",
            "id": "2034020000000015975",
            "type": "normal_profile",
            "created_by": null
        },
        {
            "display_label": "Custom Profile",
            "created_time": "2023-07-05T19:48:55+05:30",
            "modified_time": "2023-07-05T19:48:55+05:30",
            "custom": true,
            "name": "Custom Profile",
            "modified_by": {
                "name": "Zylker Travels",
                "id": "2034020000000457001"
            },
            "description": "This profile is created manually.",
            "id": "2034020000000660001",
            "type": "normal_profile",
            "created_by": {
                "name": "Zylker Travels",
                "id": "2034020000000457001"
            }
        }
    ]
}