Yoobic Groups API
Groups are used to manage users. This is VERY important as Groups are what make using the application much simpler. By adding Users to Groups, when you need to modify sets of Users, you just change the groups properties and all the Users in the Group inherit these properties (much better than changing each individual user manually). Moreover, Groups allow to restrict visibility when some entities are shared (Missions, News, Documents, ...)### How do I structure my groups ?Each Group usually corresponds to a population of Users (ex: Admin, HQ, VM Managers, Retail Area Managers, Stores, etc.).### General GroupUsually there is a general group, which has the name of the tenant.This group will contain all of the other Groups and will give the Users access to shared information.Then you will usually find a Group for each type of user. These usually fall into one of these categories:* Admin* Area Managers* HQ* Itinerants* Store Users### Fields| Field | Type | Required | Readonly | OrderBy | Description ||-----------------------------|:--------:|:--------:|:--------:|:-------:| -------------------------||`group_id` | string | | x | | The group_id corresponds to the Group title in lowercase letters, with `_` instead of spaces, and without special characters ||`title` | string | x | | | Group Title ||`description` | string | | | | Group Description ||`group_ids` | array | | | x | group ids that belong to this group ||`user_ids` | array | | | x | user ids that belong to this group ||`created_date` | date | | x | | Created Date ||`updated_date` | date | | x | x | Updated Date ||`icon_url` | string | | | | Icon URL |### TipTo summarise, remember that:* Users are organised in groups* Groups must be created prior to importing any users to the database* A user can belong to multiple groups* There can be sub-groups* Users inherit their level or rights from the group(s) they belong to
Yoobic Groups API is one of 41 APIs that Yoobic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.
This API exposes 12 operations across 8 paths, and defines 1 schema. It is described by OpenAPI 3.0.0.
Requests are made against a single base URL, https://.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Yoobic Groups API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow.
Paths & Operations 12
Across 8 paths, the API surfaces 12 operations — 3 DELETE, 4 GET, 1 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Groups are used to manage users. This is VERY important as Groups are what make using the application much simpler. By adding Users to Groups, when you need to modify sets of User…
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Default_Header (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Yoobic 12
Other APIs Yoobic publishes across the network.