Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Catchpoint UserRole API

The UserRole API from Catchpoint — 3 operation(s) for userrole.

Catchpoint UserRole API is one of 31 APIs that Catchpoint publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include UserRole. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 5 operations across 3 paths, and defines 14 schemas. It is described by OpenAPI 3.0.1, at version 2.0.

Requests are made against a single base URL, /api.

5 operations 3 paths 14 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
2.0
Base URL
https://io.catchpoint.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Catchpoint UserRole API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 5

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

UserRole 5
GET
/v2/userroles/{userRoleIds}
Return user role details by the IDs passed.
1 param → 200
GET
/v2/userroles
Return user role details by the Parameters passed
1 param → 200
POST
/v2/userroles
Create a new User Role based on the PostData.
1 param body → 200
DELETE
/v2/userroles
Delete existing User Roles by Ids.
1 param → 200
PATCH
/v2/userroles/{userRoleId}
Update an existing User Role based on the request body.
2 params body → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are Catchpoint.Symphony.REST.Common.Response.v2_0.UserRole.UserRoleAPIModel (8 properties), Catchpoint.Symphony.REST.Common.Response.v2_0.UserRoleResponseModel (7 properties), Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.UserRoleResponseModel] (6 properties), Catchpoint.Symphony.REST.Api.ApiUsageStatistics (6 properties). Each schema is shown below with its type and property counts.

Catchpoint.Symphony.REST.Common.Response.v2_0.UserRoleResponseModel
object
7 properties
Catchpoint.Symphony.REST.Api.ApiUsageStatistics
object
6 properties
Catchpoint.Symphony.REST.Api.DivisionUsageStatistics
object
2 properties
Catchpoint.Symphony.REST.Common.Models.PatchIgnoredPath
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.UserRole.UserRolePermissionAPIModel
object
4 properties
Catchpoint.Symphony.REST.Api.Limit
object
3 properties
Catchpoint.Symphony.ViewModels.EnumLookupModel`1[System.Int32]
object
2 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.UserRole.UserRoleAPIModel
object
8 properties
Catchpoint.Symphony.REST.Common.Models.InfoMessage
object
2 properties
Catchpoint.Symphony.REST.Common.Response.APIResponse`1[Catchpoint.Symphony.REST.Common.Response.v2_0.UserRoleResponseModel]
object
6 properties
Catchpoint.Symphony.REST.Common.Response.v2_0.UserRole.UserRolePermissionOptionAPIModel
object
3 properties
Microsoft.AspNetCore.JsonPatch.Operations.Operation
object
4 properties
Catchpoint.Symphony.REST.Api.ConsumerStatistics
object
3 properties
Catchpoint.Symphony.ViewModels.MessageModel
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

catchpoint-userrole-api-openapi.yml Raw ↑

Other APIs Catchpoint publishes across the network.

Catchpoint Account API
Catchpoint Alerts API
Catchpoint ASNs API
Catchpoint Assertions API
Catchpoint CommandControl API
Catchpoint Contacts API
Catchpoint Credentials API
Catchpoint Divisions API
Catchpoint EndpointDevice API
Catchpoint EndpointDevicePerformance API
Catchpoint Folder API
Catchpoint Insights API