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

Bright Pattern Users API

With the https://:tenant_url/configapi/v2/user endpoint you can:Create new users and define most of their attributesUpdate existing usersCheck and clear user lockout stateManage agents' skillsDelete existing usersBelow is a brief description of all user attributes that can be accessed via this API. More detailed descriptions of these attributes can be found here.All attributes are strings unless otherwise noted.All attributes are optional unless otherwise noted.AttributeDescriptionloginIdUsername. Required to create user. Used to identify the user in all subsequent User Management API operations.passwordPassword. Format must comply with security policy.changePasswordIndicates whether user must change password on next login. Boolean. Default is false.firstNameFirst name. Required to create user.lastNameLast name. Required to create user.teamTeam that the user is assigned to. Required to create user.extensionUser's extension number. If not specified, an extension will be created and assigned automatically.workPhoneUser's work phone number.mobilePhoneUser's mobile phone number.emailUser's email address.disabledIndication whether the user account is disabled or enabled. Boolean (true/flase).skillsFor agents an array of skills with levels (e.g., "Support": 75).rolesAn array of user's roles (e.g., Agent).

Bright Pattern Users API is one of 14 APIs that Bright Pattern publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 13 operations across 6 paths. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://{tenant_url}.

13 operations 6 paths 0 schemas 2 DELETE5 GET1 PATCH2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://{tenant}.brightpattern.com/configapi/v2
Authentication
HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Bright Pattern Users API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It supports OAuth 2.0 (oauth2ClientCredentials) using the clientCredentials flow. By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 access token issued by the Bright Pattern token endpoint, sent as Authorization: Bearer .
  • oauth2ClientCredentials — OAuth 2.0 client-credentials grant against the Bright Pattern tenant token endpoint.

Paths & Operations 13

Across 6 paths, the API surfaces 13 operations — 2 DELETE, 5 GET, 1 PATCH, 2 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 13

With the https://:tenanturl/configapi/v2/user endpoint you can: Create new users and define most of their attributes Update existing users Check and clear user lockout state Manag…

POST
/configapi/v2/user
Create User
createUser body → 200
GET
/configapi/v2/user/{username}
Get User Data
getUserData 1 param → 200
PUT
/configapi/v2/user/{username}
Update User
updateUser 1 param body → 200
DELETE
/configapi/v2/user/{username}
Delete User
deleteUser 1 param → 200
GET
/configapi/v2/user/lock/{username}
Get User Lock State
getUserLockState 1 param → 200
PUT
/configapi/v2/user/lock/{username}
Clear User Lock State
clearUserLockState 1 param → 200
GET
/configapi/v2/team
Get Teams
getTeams → 200
POST
/configapi/v2/scim/users
Create User
createUser body → 201
GET
/configapi/v2/scim/users
Get User by userName
getUserByUsername 1 param → 200
GET
/configapi/v2/scim/users/{id}
Get User by ID
getUserById 1 param → 200
PUT
/configapi/v2/scim/users/{id}
Replace User Properties (by replacing all existing attributes with a specified set of replacement attributes)
replaceUserProperties 1 param body → 200
DELETE
/configapi/v2/scim/users/{id}
Delete User
deleteUser 1 param → 204
PATCH
/configapi/v2/scim/users/{id}
Update User (updates only the properties indicated in the specified set)
updateUser 1 param body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bright-pattern-users-api-openapi.yml Raw ↑

Other APIs Bright Pattern publishes across the network.

Bright Pattern Authentication API
Bright Pattern Calling List API
Bright Pattern Campaigns API
Bright Pattern DNC Lists API
Bright Pattern Do Not Call List API
Bright Pattern Link Groups API
Bright Pattern Lists API
Bright Pattern Methods API
Bright Pattern Multichannel Call Recordings API
Bright Pattern Phones API
Bright Pattern Regular Call Recordings API
Bright Pattern SMS/MMS Messaging API
Where this information came from

This is an independent, third-party profile of Bright Pattern Users 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.