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

Webscale Networks Users API

The Users API from Webscale Networks — 13 operation(s) for users.

Webscale Networks Users API is one of 25 APIs that Webscale Networks 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, an API reference, API documentation, and authentication docs.

This API exposes 20 operations across 13 paths, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version 2026.273.

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

20 operations 13 paths 32 schemas 3 DELETE12 GET3 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026.273
Base URL
https://api.webscale.com/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Webscale Networks Users API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (access_key). By default, every request must be authenticated.

  • access_key — An access key secret must be sent as a [bearer token](https://www.rfc-editor.org/rfc/rfc7235section-5.1) with each HTTP request in an Authorization header. Tok…

Paths & Operations 20

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

Users 20
GET
/users
Read user collection
getUsers → 200
GET
/users/{id}
Read a user
getUsersById 1 param → 200
PATCH
/users/{id}
Update a user
patchUsersById 1 param body → 200
GET
/users/{id}/access-keys
Read access keys collection
getUsersByIdAccessKeys 1 param → 200
POST
/users/{id}/access-keys
Create an access key
postUsersByIdAccessKeys 1 param body → 200
DELETE
/users/{user_id}/access-keys/{id}
Delete an access key
deleteUsersByUserIdAccessKeysById 2 params → 200
GET
/users/{id}/authorization
Read authorization
getUsersByIdAuthorization 1 param → 200
POST
/users/{id}/authorization
Create authorization
postUsersByIdAuthorization 1 param body → 200
GET
/users/{id}/group-invitations
Read group invitations
getUsersByIdGroupInvitations 1 param → 200
GET
/users/{id}/group-invitations/{group-invitation-id}
Read a group invitation
getUsersByIdGroupInvitationsByGroupInvitationId 2 params → 200
PATCH
/users/{id}/group-invitations/{group-invitation-id}
Update a group invitation
patchUsersByIdGroupInvitationsByGroupInvitationId 2 params body → 200
GET
/users/{id}/groups
Read user group collection
getUsersByIdGroups 1 param → 200
GET
/users/{id}/groups/{group_id}
Read group membership
getUsersByIdGroupsByGroupId 2 params → 200
DELETE
/users/{id}/groups/{group_id}
Delete group membership
deleteUsersByIdGroupsByGroupId 2 params → 200
GET
/users/{id}/invitations
Read role invitations
getUsersByIdInvitations 1 param → 200
GET
/users/{id}/invitations/{invitation_id}
Read a role invitation
getUsersByIdInvitationsByInvitationId 2 params → 200
PATCH
/users/{id}/invitations/{invitation_id}
Update a role invitation
patchUsersByIdInvitationsByInvitationId 2 params body → 200
GET
/users/{id}/roles
Read role membership collection
getUsersByIdRoles 1 param → 200
GET
/users/{id}/roles/{role_id}
Read role membership
getUsersByIdRolesByRoleId 2 params → 200
DELETE
/users/{id}/roles/{role_id}
Delete role membership
deleteUsersByIdRolesByRoleId 2 params → 200

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are RoleConfiguration (6 properties), UserPatch (5 properties), GroupInvitationState (4 properties), RoleInvitationState (4 properties). Each schema is shown below with its type and property counts.

Group
A collection of roles granted to users of an account
RoleInvitation
A invitation to a user role
GroupInvitationState
object
The current state of a group invitation
4 properties
AccessKeySecret
RoleIdentity
object
Identifier for a role
1 property
GroupInvitationIdentity
object
The identifier for a group invitation.
1 property
GroupConfiguration
object
The configurable parts of a group
3 properties
AccountHref
string
A reference to an account
AccessKeyState
object
3 properties
GroupedRoleState
object
The current state of a group
2 properties
AccessKey
A key that is used to authorize access to the Webscale API
UserPatch
object
5 properties
Timestamp
string
An iso8601 formatted timestamp
PositiveInteger
integer
An integer of value 1 or more.
AccessKeyConfiguration
object
An authorization granted to a user
3 properties 1 required
RoleInvitationState
object
The current state of a role invitation
4 properties
GroupInvitationInitializer
object
A group invitation invites a user to a particular group.
2 properties
RoleInvitationInitializer
object
The current state of a role invitation
2 properties
RoleInvitationConfiguration
object
The configurable parts of a role invitation
1 property
Email
string
An email address
User
object
GroupInvitationConfiguration
object
The configurable parts of a group invitation
1 property
RoleConfiguration
object
The configurable parts of a role
6 properties
Permissions
object
3 properties 3 required
Role
A generic role granted to users of an account
AuthorizationAccount
object
The account for which an authorization is to be created
1 property 1 required
RoleInvitationIdentity
object
Identifier for a role invitation
1 property
GroupInvitation
An invitation to a group.
GroupIdentity
object
Identifier for a group
1 property
RoleState
object
The current state of a role
2 properties
Name
string
Roles
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

webscale-networks-users-api-openapi.yml Raw ↑

Other APIs Webscale Networks publishes across the network.

Webscale Networks Accounts API
Webscale Networks Address sets API
Webscale Networks Application test API
Webscale Networks Applications API
Webscale Networks Builders API
Webscale Networks Clusters API
Webscale Networks Environments API
Webscale Networks Files API
Webscale Networks Groups API
Webscale Networks Labelers API
Webscale Networks Log schemas API
Webscale Networks Logs API
Where this information came from

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