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

Instana Groups API

Groups are used to permit individual users to perform specific actions and get visibility to an access scope. Each user can be assigned to multiple groups, every one coming with its associated permissions. In addition a group sets the access scope and you can configure the visible areas for the group members.When you are a member of multiple groups, your permissions have an additive effect.Granting access to certain entities within Instana (e.g. Applications, Kubernetes Clusters etc.) is done through a corresponding entry in the `permissionSet` payload.

Instana Groups API is one of 62 APIs that Instana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 19 operations across 12 paths, and defines 10 schemas. It is described by OpenAPI 3.0.1, at version 1.307.1417.

Requests are made against 2 base URLs: https://{unit}-{tenant}.instana.io, https://{domain}.

19 operations 12 paths 10 schemas 3 DELETE7 GET2 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.307.1417
Servers
https://{unit}-{tenant}.instana.io
https://{domain}
Authentication
API Key
Contact
Terms of Service
Resource Areas
1

Authentication & Security 1

Instana Groups API declares 1 security scheme for authenticating requests. An API key is passed in the header as authorization (ApiKeyAuth).

  • ApiKeyAuth — Example bash curl --request GET \ --url https://test-instana.instana.io/api/application-monitoring/catalog/metrics \ --header 'authorization: apiToken xxxxxxxx…

Paths & Operations 19

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

Groups 19

Groups are used to permit individual users to perform specific actions and get visibility to an access scope. Each user can be assigned to multiple groups, every one coming with i…

GET
/api/settings/rbac/groups
Get groups
getGroups → 200404
POST
/api/settings/rbac/groups
Create group
createGroup body → 200
PUT
/api/settings/rbac/groups/delete
Delete groups
deleteGroups body → default
GET
/api/settings/rbac/groups/user/{email}
Get groups of a single user
getGroupsByUser 1 param → 200404
PUT
/api/settings/rbac/groups/{groupId}/permissions
Add permissions to group
addPermissionsOnGroup 1 param body → 200
PUT
/api/settings/rbac/groups/{groupId}/users
Add users to group
addUsersToGroup 1 param body → 200
DELETE
/api/settings/rbac/groups/{id}
Delete group
deleteGroup 1 param → default
GET
/api/settings/rbac/groups/{id}
Get group
getGroup 1 param → 200
PUT
/api/settings/rbac/groups/{id}
Update group
updateGroup 1 param body → 200
DELETE
/api/settings/rbac/groups/{id}/user/{userId}
Remove user from group
removeUserFromGroup 2 params → default
GET
/api/settings/rbac/mappings
Get all group mappings
getGroupMappings → 200404
POST
/api/settings/rbac/mappings
Create group mapping
createGroupMapping body → 200
PUT
/api/settings/rbac/mappings/delete
Delete multiple group mappings
deleteGroupMappings body → 204422
GET
/api/settings/rbac/mappings/identityProvider/restrictEmptyIdpGroups
Check user restrictions for empty Idp group mapping
getIdentityProviderPatch → 200404
PUT
/api/settings/rbac/mappings/identityProvider/restrictEmptyIdpGroups
Allow/Restrict users with empty Idp group mapping
updateIdentityProvider body → default
GET
/api/settings/rbac/mappings/overview
Get all group mappings overview
getGroupMappingsOverview → 200404
DELETE
/api/settings/rbac/mappings/{id}
Delete group mapping
deleteGroupMapping 1 param → default
GET
/api/settings/rbac/mappings/{id}
Get group mapping
getGroupMapping 1 param → 200404
PUT
/api/settings/rbac/mappings/{id}
Update group mapping
updateGroupMapping 1 param body → 200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ApiPermissionSet (13 properties), GroupMapping (5 properties), GroupMappingOverview (5 properties), ApiGroup (4 properties). Each schema is shown below with its type and property counts.

ScopeBinding
object
2 properties
GroupMapping
object
5 properties 3 required
GroupMappingOverview
object
5 properties
ApiMember
object
3 properties 1 required
ApiRestrictedApplicationFilter
object
4 properties
ApiCreateGroup
object
3 properties 3 required
ApiGroup
object
4 properties 4 required
TagFilterExpressionElement
object
Boolean expression of tag filters to define the scope of relevant calls.
1 property 1 required
ApiPermissionSet
object
13 properties 11 required
IdentityProviderPatch
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

instana-groups-api-openapi.yml Raw ↑

Other APIs Instana publishes across the network.

Instana Action Catalog API
Instana Action History API
Instana AI Management API
Instana Apdex Report API
Instana Apdex Settings API
Instana API Token API
Instana Application Alert Configuration API
Instana Application Analyze API
Instana Application Catalog API
Instana Application Metrics API
Instana Application Resources API
Instana Application Settings API