Yoobic Roles API
Get the list of Roles available for the users in your organization. The roles are defined by a combination of `client_role` and `client_role_extension`The `client_role` refers to a YOOBIC specific role name between ROLEFIELD, ROLEMANAGER, ROLEEDITOR, ROLESTOREMANAGER, ROLESTORE, ROLEADMIN, and ROLEVIEWER and has an impact on some default features of the platform. It also determines what license level the user is attached to.The `client_role_extension` refers to a customer-specific designation of a user role, usually based on the job or responsibility of the teams. It is used to differentiate users with the same license level but access to different modules of the platform.Each combination of client_role and `client_role_extension` is given a unique acl_role_id at creationRoles are created during the implementation of the platform and cannot be changed by an administrator either via the public API or from the admin interface.### Fields| Field | Type | Required | Readonly | OrderBy | Description ||------------------------|:--------------:|:--------:|:--------:|:-------:|---------------------------||`acl_role_id` | string | x | x | | Unique id of the role object ||`client_role` | string | x | x | | User roles: ROLEFIELD | ROLEMANAGER | ROLEEDITOR | ROLESTOREMANAGER | ROLESTORE | ROLEADMIN | ROLEVIEWER ||`client_role_extension` | string | x | x | | Additional role information ||`created_date` | date | | x | | Creation date ||`updated_date` | date | | x | x | Last update date |
Yoobic Roles API is one of 41 APIs that Yoobic publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a changelog.
This API exposes 4 operations across 4 paths, and defines 1 schema. It is described by OpenAPI 3.2.0, at version 1.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 Roles API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth2) using the authorizationCode flow.
Paths & Operations 4
Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.
Get the list of Roles available for the users in your organization. The roles are defined by a combination of clientrole and clientroleextension The clientrole refers to a YOOBIC…
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.
This is an independent, third-party profile of Yoobic Roles API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.