Skip to main content
Version: v41
Version: 99

PrivX Role Store

SSH PrivX Role Store API for client operations. It 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):

Token URL: /auth/api/v1/oauth/token

Authorization URL: /auth/api/v1/oauth/authorize

Scopes:

  • admin: admin user access

  • authorizedKeysManage: manage authorized keys

  • apiClient: API client access

  • hostsProvisioning: provision hosts using the deploy script

  • logsManage: manage logs

  • rolesManage: manage roles

  • rolesView: view roles

  • roleTargetResourcesManage: manage roles target resources

  • roleTargetResourcesView: view roles target resources

  • service: cross-service access

  • sourcesManage: manage source directories

  • sourcesView: view source directories

  • user: normal user access

  • usersManage: manage users

  • usersView: view users