How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Genesys

Genesys Authorization API

Roles and permissions

Documentation Provider Profile APIs.io OpenAPI GitHub

Genesys Authorization API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Authorization. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 59 operations across 41 paths, and defines 124 schemas. It is described by OpenAPI 3.2.0, at version v2.

Requests are made against a single base URL, https://api.mypurecloud.com.

59 operations 41 paths 124 schemas 4 DELETE30 GET2 PATCH14 POST9 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2
Base URL
https://api.mypurecloud.com
Authentication
OAuth 2.0, API Key
Contact
PureCloud Developer Evangelists
License
UNLICENSED
Terms of Service
View terms
Resource Areas
1

Authentication & Security 2

Genesys Authorization API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (PureCloud_OAuth) using the implicit flow, exposing 1 scope. An API key is passed in the header as Authorization (Guest_Chat_JWT).

Paths & Operations 59

Across 41 paths, the API surfaces 59 operations — 4 DELETE, 30 GET, 2 PATCH, 14 POST, 9 PUT. Each is listed below with its method, path, parameters, and response codes.

Authorization 59

Roles and permissions

GET
/api/v2/authorization/divisions/home
Retrieve the home division for the organization
getAuthorizationDivisionsHome → 200400401403404408409413
GET
/api/v2/authorization/divisions/limit
Returns the maximum allowed number of divisions
getAuthorizationDivisionsLimit → 200400401403404408409413
GET
/api/v2/authorization/divisions/{divisionId}
Returns an authorization division
getAuthorizationDivision 2 params → 200400401403404408409413
PUT
/api/v2/authorization/divisions/{divisionId}
Update a division
putAuthorizationDivision 1 param body → 200400401403404408409413
DELETE
/api/v2/authorization/divisions/{divisionId}
Delete a division
deleteAuthorizationDivision 2 params → 204400401403404408409413
POST
/api/v2/authorization/divisions/{divisionId}/restore
Recreate a previously deleted division
postAuthorizationDivisionRestore 1 param body → 200400401403404408409413
GET
/api/v2/authorization/divisions/deleted
Get a list of soft deleted divisions for the org
getAuthorizationDivisionsDeleted 2 params → 200400401403404408409413
GET
/api/v2/authorization/divisions/query
Retrieve a list of all divisions defined for the organization with cursor
getAuthorizationDivisionsQuery 5 params → 200400401403404408409413
GET
/api/v2/authorization/divisions
Retrieve a list of all divisions defined for the organization
getAuthorizationDivisions 9 params → 200400401403404408409413
POST
/api/v2/authorization/divisions
Create a division
postAuthorizationDivisions body → 200400401403404408409413
GET
/api/v2/authorization/policies/targets/{targetName}
Get a page of access policies for a given policy target
getAuthorizationPoliciesTarget 3 params → 200400401403404408409413
POST
/api/v2/authorization/policies/targets/{targetName}
Add an access control policy for a specified resource target and subject
postAuthorizationPoliciesTarget 2 params body → 200201400401403404408409
PUT
/api/v2/authorization/policies/targets/{targetName}
Add an access control policy for a specified resource target and subject…
putAuthorizationPoliciesTarget 2 params body → 200400401403404408409413
POST
/api/v2/authorization/policies/targets/{targetName}/validate
Validate the conditions and attributes of an access control policy for a…
postAuthorizationPoliciesTargetValidate 1 param body → 200400401403404408409413
GET
/api/v2/authorization/policies
Get a page of access policies for an organization
getAuthorizationPolicies 2 params → 200400401403404408409413
GET
/api/v2/authorization/policies/subject/{subjectId}
Get a page of access policies for a given subject
getAuthorizationPoliciesSubjectSubjectId 3 params → 200400401403404408409413
GET
/api/v2/authorization/policies/targets/{targetName}/subject/{subjectId}
Get an access control policy for a specified resource target and subject
getAuthorizationPoliciesTargetSubjectSubjectId 2 params → 200400401403404408409413
DELETE
/api/v2/authorization/policies/targets/{targetName}/subject/{subjectId}
Delete an access control policy
deleteAuthorizationPoliciesTargetSubjectSubjectId 2 params → 204400401403404408409413
GET
/api/v2/authorization/policies/{policyId}
Get an access control policy with the specified policy ID
getAuthorizationPolicy 1 param → 200400401403404408409413
PUT
/api/v2/authorization/policies/{policyId}
Update an access control policy with a given ID
putAuthorizationPolicy 2 params body → 200400401403404408409413
GET
/api/v2/authorization/policies/{policyId}/attributes
Get the list of attributes used to evaluate an access control policy with the…
getAuthorizationPolicyAttributes 1 param → 200400401403404408409413
POST
/api/v2/authorization/policies/{policyId}/simulate
Simulate a request and evaluate the specified policy ID against the provided…
postAuthorizationPolicySimulate 1 param body → 200400401403404408409413
GET
/api/v2/authorization/policies/targets
Get a map of policy targets to valid attributes for those targets
getAuthorizationPoliciesTargets → 200400401403404408409413
GET
/api/v2/authorization/divisionspermitted/medeprecated
Returns which divisions the current user has the given permission in
getAuthorizationDivisionspermittedMe 2 params → 200400401403404408409413
GET
/api/v2/authorization/divisionspermitted/paged/me
Returns which divisions the current user has the given permission in
getAuthorizationDivisionspermittedPagedMe 3 params → 200400401403404408409413
GET
/api/v2/authorization/divisionspermitted/paged/{subjectId}deprecated
Returns which divisions the specified user has the given permission in
getAuthorizationDivisionspermittedPagedSubjectId 4 params → 200400401403404408409413
GET
/api/v2/authorization/permissions
Get all permissions
getAuthorizationPermissions 4 params → 200400401403404408409413
GET
/api/v2/authorization/products
Get the list of enabled products
getAuthorizationProducts → 200400401403404408409413
POST
/api/v2/authorization/divisions/{divisionId}/objects/{objectType}
Assign a list of objects to a division
postAuthorizationDivisionObject 2 params body → 204400401403404408409413
GET
/api/v2/authorization/subjects/me
Returns a listing of roles and permissions for the currently authenticated user
getAuthorizationSubjectsMe 1 param → 200400401403404408409413
GET
/api/v2/authorization/subjects/{subjectId}
Returns a listing of roles and permissions for a user
getAuthorizationSubject 2 params → 200400401403404408409413
POST
/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}
Make a grant of a role in a division
postAuthorizationSubjectDivisionRole 4 params → default400401403404408409413
DELETE
/api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId}
Delete a grant of a role in a division
deleteAuthorizationSubjectDivisionRole 3 params → default400401403404408409413
POST
/api/v2/authorization/subjects/{subjectId}/bulkadd
Bulk-grant roles and divisions to a subject
postAuthorizationSubjectBulkadd 2 params body → 204400401403404408409413
POST
/api/v2/authorization/subjects/{subjectId}/bulkreplace
Replace subject's roles and divisions with the exact list supplied in the…
postAuthorizationSubjectBulkreplace 2 params body → 204400401403404408409413
POST
/api/v2/authorization/subjects/{subjectId}/bulkremove
Bulk-remove grants from a subject
postAuthorizationSubjectBulkremove 1 param body → 204400401403404408409413
GET
/api/v2/authorization/roles/{roleId}/users
Get a list of the users in a specified role
getAuthorizationRoleUsers 3 params → 200400401403404408409413
PUT
/api/v2/authorization/roles/{roleId}/users/add
Sets the users for the role
putAuthorizationRoleUsersAdd 1 param body → 200400401403404408409413
PUT
/api/v2/authorization/roles/{roleId}/users/remove
Removes the users from the role
putAuthorizationRoleUsersRemove 1 param body → 200400401403404408409413
GET
/api/v2/authorization/divisions/{divisionId}/grants
Gets all grants for a given division
getAuthorizationDivisionGrants 3 params → 200400401403404408409413
GET
/api/v2/authorization/settings
Get authorization settings
getAuthorizationSettings → 200400401403404408409413
PATCH
/api/v2/authorization/settings
Change authorization settings
patchAuthorizationSettings body → 200400401403404408409413
GET
/api/v2/authorization/roles/settings
Get authorization role settings
getAuthorizationRolesSettings → 200400401403404408409413
PUT
/api/v2/authorization/roles/settings
Change authorization role settings
putAuthorizationRolesSettings body → 200400401403404408409413
GET
/api/v2/authorization/roles/{roleId}
Get a single organization role
getAuthorizationRole 3 params → 200400401403404408409413
POST
/api/v2/authorization/roles/{roleId}
Bulk-grant subjects and divisions with an organization role
postAuthorizationRole 2 params body → 204400401403404408409413
PUT
/api/v2/authorization/roles/{roleId}
Update an organization role
putAuthorizationRole 1 param body → 200400401403404408409413
DELETE
/api/v2/authorization/roles/{roleId}
Delete an organization role
deleteAuthorizationRole 1 param → default400401403404408409413
PATCH
/api/v2/authorization/roles/{roleId}
Patch Organization Role for needsUpdate Field
patchAuthorizationRole 1 param body → 200400401403404408409413
GET
/api/v2/authorization/roles
Retrieve a list of all roles defined for the organization
getAuthorizationRoles 11 params → 200400401403404408409413
POST
/api/v2/authorization/roles
Create an organization role
postAuthorizationRoles body → 200400401403404408409413
POST
/api/v2/authorization/roles/default
Restores all default roles
postAuthorizationRolesDefault 1 param → 200400401403404408409413
PUT
/api/v2/authorization/roles/default
Restore specified default roles
putAuthorizationRolesDefault body → 200400401403404408409413
GET
/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}
Get an org role to default role comparison
getAuthorizationRoleComparedefaultRightRoleId 2 params → 200400401403404408409413
POST
/api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId}
Get an unsaved org role to default role comparison
postAuthorizationRoleComparedefaultRightRoleId 2 params body → 200400401403404408409413
GET
/api/v2/authorization/roles/{roleId}/subjectgrants
Get the subjects' granted divisions in the specified role
getAuthorizationRoleSubjectgrants 7 params → 200400401403404408409413
GET
/api/v2/authorization/subjects/rolecounts
Get the count of roles granted to a list of subjects
getAuthorizationSubjectsRolecounts 1 param → 200400401403404408409413
GET
/api/v2/users/{subjectId}/roles
Returns a listing of roles and permissions for a user
getUserRoles 1 param → 200400401403404408409413
PUT
/api/v2/users/{subjectId}/roles
Sets the user's roles
putUserRoles 1 param body → 200400401403404408409413

Schemas 124

The contract defines 124 schemas that model the data the API accepts and returns. The most detailed are QueueFullReference (41 properties), UserFullReference (39 properties), User (39 properties), InboundRoute (19 properties). Each schema is shown below with its type and property counts.

AddressableEntityRef
object
2 properties
CallbackMediaSettings
object
18 properties
PresenceDefinition
object
3 properties
RoleDivisionPair
object
2 properties 2 required
DomainEntityRef
object
3 properties
OutOfOffice
object
8 properties
TeamFullReference
object
8 properties 1 required
MessageSubtypeSettings
object
2 properties
Detail
object
4 properties
EmployerInfo
object
4 properties
LocationImage
object
2 properties
UserStations
object
4 properties
User
object
39 properties 1 required
DirectRoutingMediaSettings
object
1 property
DomainResourceConditionValue
object
5 properties
Location
object
5 properties
AuthzGrantRole
object
6 properties
PolicyConditionResult
object
2 properties
Bullseye
object
1 property
OrganizationProductEntityListing
object
5 properties
ConditionalGroupActivationRule
object
3 properties
AuthzDivision
object
6 properties 1 required
RoutingStatus
object
3 properties
TypedAttribute
object
2 properties
GroupContact
object
5 properties 3 required
LocationEmergencyNumber
object
3 properties
QueueMediaSettings
object
5 properties
InboundRoute
object
19 properties 2 required
EmailAddress
object
2 properties
Ring
object
3 properties
UserConversationSummary
object
8 properties
Actions
object
1 property
SubjectDivisions
object
2 properties 2 required
UserReferenceEntityListing
object
5 properties
Biography
object
5 properties
UserRoutingLanguage
object
Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id.
6 properties
DivsPermittedEntityListing
object
11 properties
Script
object
15 properties
LocationAddressVerificationDetails
object
4 properties
WritableDivision
object
3 properties
AgentOwnedRouting
object
3 properties
DomainOrgRoleDifference
object
5 properties
UserReference
object
2 properties
Education
object
5 properties
AuthorizationPolicy
object
12 properties 2 required
QueueEmailAddress
object
2 properties
UserRoutingSkill
object
Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.
6 properties
ConditionalGroupActivationPilotRule
object
2 properties
ValidationErrorResponse
object
3 properties
AuthzGrantPolicy
object
4 properties
UserFullReference
object
39 properties 1 required
ErrorBody
object
11 properties
RoutingRule
object
3 properties
MessageMediaSettings
object
8 properties
SubjectDivisionGrants
object
5 properties
ConditionalGroupRouting
object
1 property
ConditionalGroupRoutingRule
object
6 properties
MediaSettings
object
5 properties
WorkPlanBidRanks
object
4 properties
UserAuthorization
object
4 properties
AuthzSubject
object
5 properties
ExpansionCriterium
object
2 properties
PermissionCollectionEntityListing
object
10 properties
DomainOrganizationProduct
object
1 property
RoleDivisionGrants
object
1 property 1 required
AuthorizationSettings
object
6 properties
SkillsToRemove
object
3 properties
RoleSettings
object
4 properties
DomainOrganizationRole
object
15 properties
SubjectDivisionGrantsEntityListing
object
10 properties
ServiceLevel
object
2 properties
UserPresence
object
10 properties
AuthzDivisionEntityListing
object
10 properties
TargetAttributeValue
object
2 properties
LocationDefinition
object
16 properties
AuthzDivisionGrantEntityListing
object
5 properties
DomainPermissionPolicy
object
8 properties
Division
object
3 properties
DomainOrganizationRoleUpdate
object
6 properties 1 required
LocationAddress
object
7 properties
Limit
object
3 properties
CannedResponseLibraries
object
2 properties
ValidationErrorListing
object
1 property
Signature
object
4 properties
AuthorizationPolicyEntityListing
object
4 properties
Chat
object
1 property
DomainPermissionCollection
object
5 properties
DomainResourceConditionNode
object
5 properties
Page
object
8 properties
ConditionalGroupActivation
object
2 properties
Subject
object
2 properties
MemberGroup
object
6 properties
MediaSummary
object
2 properties
UserStation
object
8 properties
OrganizationRoleEntityListing
object
10 properties
PolicyCondition
object
DomainPermission
object
6 properties
Geolocation
object
11 properties
Contact
object
7 properties
Team
object
8 properties 1 required
DomainOrganizationRoleCreate
object
15 properties 1 required
QueueFullReference
object
41 properties
EmailMediaSettings
object
5 properties
ResourcePermissionPolicy
object
11 properties
ConditionalGroupActivationSimpleMetric
object
2 properties
Image
object
2 properties
AuthzDivisionCursorListing
object
4 properties
ResourceConditionNode
object
5 properties
ResourceConditionValue
object
2 properties
ConditionalGroupActivationCondition
object
3 properties
OAuthLastTokenIssued
object
1 property
PolicyTestResult
object
4 properties
InactivityTimeoutSettings
object
3 properties
DomainRole
object
2 properties
AuthzGrant
object
4 properties
TargetAttributes
object
2 properties
PolicyAttribute
object
4 properties
PolicyTestPayload
object
1 property 1 required
QueueMessagingAddresses
object
3 properties
MediaSummaryDetail
object
2 properties
AcwSettings
object
2 properties
DirectRouting
object
6 properties
PolicyAttributeSet
object
5 properties
Group
object
17 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-authorization-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
AE Profile APIs.io
Genesys Agent Copilot API
AE Profile APIs.io
Genesys Agent UI API
AE Profile APIs.io
Genesys AI Studio API
AE Profile APIs.io
Genesys Alerting API
AE Profile APIs.io
Genesys Analytics API
AE Profile APIs.io
Genesys Architect API
AE Profile APIs.io
Genesys Assistant Copilot Variations API
AE Profile APIs.io
Genesys Audit API
AE Profile APIs.io
Genesys Background Assistant API
AE Profile APIs.io
Genesys Billing API
AE Profile APIs.io
Genesys Business Rules API
AE Profile APIs.io
#Authorization
← Back to G APIs
API Details
ID
genesys:genesys-authorization-api
Base URL
https://api.mypurecloud.com
Docs
https://developer.genesys.cloud/platform/api/
Provider
Genesys
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=genesys-authorization-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/genesys-authorization-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Genesys Authorization 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.