Skip to main content
Version: v40
Version: 99

SSH PrivX Role Store API

The PrivX Role Store API allows clients to add user and host sources, configure roles and role mappings.

Authentication​

PrivX OAuth2 authorization flow

Security Scheme Type:

oauth2

OAuth Flow (authorizationCode):

Scopes:

  • admin: Admin scope - used for built-in PrivX admin account

  • authorizedKeysManage: User with "authorized-keys-manage" permission

  • apiClient: API Client scope - used for scripted access

  • hostsProvisioning: Deploy script client scope

  • logsManage: Admin with "logs-manage" permission

  • rolesManage: User with "roles-manage" permission

  • rolesView: User with "roles-view" permission

  • roleTargetResourcesManage: User with "role-target-resources-manage" permission

  • roleTargetResourcesView: User with "role-target-resources-view" permission

  • service: Microservice scope - used for communication between PrivX microservices

  • sourcesManage: User with "sources-manage" permission

  • sourcesView: User with "source-view scope" permission

  • user: Normal user

  • usersManage: User with "users-manage" permission

  • usersView: User with "users-view" permission