Hub REST API Reference

This section contains all currently public REST API methods in Hub.

Auth Modules
- Auto Join Groups of Auth Module
  - Add Auto Join Group to Auto Join Groups of a Auth Module
  - Get All Auto Join Groups of a Auth Module
  - Get Auto Join Group from Auto Join Groups of a Auth Module
  - Remove Auto Join Group from Auto Join Groups of a Auth Module
- Create New Auth Module
- Custom Attribute Mappings of Auth Module
  - Add Custom Attribute Mapping to Custom Attribute Mappings of a Auth Module
  - Get All Custom Attribute Mappings of a Auth Module
  - Get Custom Attribute Mapping from Custom Attribute Mappings of a Auth Module
  - Remove Custom Attribute Mapping from Custom Attribute Mappings of a Auth Module
- Delete Existing Auth Module
- External Group Mappings of Auth Module
  - Add External Group Mapping to External Group Mappings of a Auth Module
  - Get All External Group Mappings of a Auth Module
  - Get External Group Mapping from External Group Mappings of a Auth Module
  - Remove External Group Mapping from External Group Mappings of a Auth Module
- Get All Auth Modules
- Get Auth Module
- Get Idpconnectioninfo
- Get Idpgroups
- Get QueryAssist
- Group Mappings of Auth Module
  - Add Group Mapping to Group Mappings of a Auth Module
  - Get All Group Mappings of a Auth Module
  - Get Group Mapping from Group Mappings of a Auth Module
  - Remove Group Mapping from Group Mappings of a Auth Module
- Post Idpfulldataload
- Post Idprefreshconnectioninfo
- Post Resolve
- Post ScheduleBy Authmodules Id Synchronization Schedule
- Post ScheduleBy Authmodules Synchronization Schedule
- Post Strength
- Post TestLogin
- Post {operation}
- Update Existing Auth Module
Certificates
- Create New Certificate
- Delete Existing Certificate
- Get All Certificates
- Get Certificate
- Get QueryAssist
- Update Existing Certificate
Events
- Create New Event
- Delete Existing Event
- Get All Events
- Get Event
- Get QueryAssist
- Update Existing Event
Hub Features
- Get All Hub Features
- Get Enabled
- Get Hub Feature
- Get QueryAssist
- Update Existing Hub Feature
JSON Scheme
Key Stores
- Create New Key Store
- Delete Existing Key Store
- Get All Key Stores
- Get Key Store
- Get QueryAssist
- Update Existing Key Store
Metrics
- Get All Metrics
- Get Metrics
- Get OpenMetrics
- Get QueryAssist
Orgs
- Authmodules of Org
- Certificates of Org
- Create New Org
- Delete Existing Org
- Get
- Get All Orgs
- Get Org
- Get QueryAssist
- Keystores of Org
- Profile Attribute Prototypes of Org
- Services of Org
- Update Existing Org
- Userdetails of Org
- Usergroups of Org
- Workspaces of Org
Permissions
- Create New Permission
- Delete Existing Permission
- Get All Permissions
- Get Cache
- Get Permission
- Get QueryAssist
- Update Existing Permission
Profile Attribute Prototypes
- Create New Profile Attribute Prototype
- Delete Existing Profile Attribute Prototype
- Get All Profile Attribute Prototypes
- Get Profile Attribute Prototype
- Get QueryAssist
- Update Existing Profile Attribute Prototype
Project Roles
- Get All Project Roles
- Get Project Role
- Get QueryAssist
Projects
- Create New Project
- Delete Existing Project
- Get All Projects
- Get Global
- Get IconBy Default
- Get IconBy Key Name
- Get Project
- Get QueryAssist
- Transitive Project Roles of Project
  - Get All Transitive Project Roles of a Project
  - Get Transitive Project Role from Transitive Project Roles of a Project
- Update Existing Project
Roles
- Create New Role
- Delete Existing Role
- Get All Roles
- Get QueryAssist
- Get Role
- Permissions of Role
- Post Merge
- Post Reset
- Post Servicepermissions
- Update Existing Role
Service Provider Metadatas
- Create New Service Provider Metadata
- Delete Existing Service Provider Metadata
- Get All Service Provider Metadatas
- Get QueryAssist
- Get Service Provider Metadata
- Update Existing Service Provider Metadata
Services
- Create New Service
- Default Roles of Service
- Delete Existing Service
- Get All Services
- Get Header
- Get QueryAssist
- Get Service
- Permissions of Service
- Post InvalidateCache
- Project Roles of Service
- Untrusted Redirect U R Is of Service
- Update Existing Service
- Viewers of Service
Settings(/health)
- Get All Settings
- Get Liveness
- Get QueryAssist
- Get Readiness
- Get Settings
- Get Startup
Settings(/settings)
- Create New Setting
- Delete
- Delete Existing Setting
- Get All Settings
- Get Locales
- Get QueryAssist
- Get Setting
- Post BackupData
- Post Message
- Post Reset
- Post Test
- Update Existing Setting
User Details
- Create New User Detail
- Delete Existing User Detail
- Get All User Details
- Get QueryAssist
- Get User Detail
- Post Revoke
- Update Existing User Detail
User Groups
- Create New User Group
- Delete Existing User Group
- Get All User Groups
- Get Forest
- Get QueryAssist
- Get Root
- Get User Group
- Post Merge
- Project Roles of User Group
- Sourced Project Roles of User Group
  - Get All Sourced Project Roles of a User Group
  - Get Sourced Project Role from Sourced Project Roles of a User Group
- Subgroups of User Group
- Transitive Project Roles of User Group
  - Get All Transitive Project Roles of a User Group
  - Get Transitive Project Role from Transitive Project Roles of a User Group
- Update Existing User Group
- Updaters of User Group
- Users of User Group
- Viewers of User Group
Users
- Application Passwords of User
  - Add Application Password to Application Passwords of a User
  - Get All Application Passwords of a User
  - Get Application Password from Application Passwords of a User
  - Remove Application Password from Application Passwords of a User
- Approved Scopes of User
  - Get All Approved Scopes of a User
  - Get Approved Scope from Approved Scopes of a User
  - Remove Approved Scope from Approved Scopes of a User
- Create New User
- Delete EndUserAgreementConsent
- Delete Existing User
- Delete Registration
- Delete TwoFactorAuthentication
- Favorite Projects of User
  - Add Favorite Project to Favorite Projects of a User
  - Get All Favorite Projects of a User
  - Get Favorite Project from Favorite Projects of a User
  - Remove Favorite Project from Favorite Projects of a User
- Get All Users
- Get Guest
- Get Personal Data
- Get QueryAssist
- Get Registration
- Get User
- Groups of User
  - Add Group to Groups of a User
  - Get All Groups of a User
  - Get Group from Groups of a User
  - Remove Group from Groups of a User
- Permanent Tokens of User
  - Add Permanent Token to Permanent Tokens of a User
  - Get All Permanent Tokens of a User
  - Get Permanent Token from Permanent Tokens of a User
  - Remove Permanent Token from Permanent Tokens of a User
- Post Confirm
- Post CreateBypassToken
- Post CreateToken
- Post EndUserAgreementConsent
- Post Erase
- Post Invite
- Post InviteUsers
- Post Merge
- Post Registration
- Post RemoveLocale
- Post TwoFactorAuthentication
- Post VerifyContact
- Project Roles of User
  - Add Project Role to Project Roles of a User
  - Get All Project Roles of a User
  - Get Project Role from Project Roles of a User
  - Remove Project Role from Project Roles of a User
- Refresh Tokens of User
  - Get All Refresh Tokens of a User
  - Get Refresh Token from Refresh Tokens of a User
  - Remove Refresh Token from Refresh Tokens of a User
- Sourced Project Roles of User
  - Get All Sourced Project Roles of a User
  - Get Sourced Project Role from Sourced Project Roles of a User
- Ssh Public Keys of User
  - Add Ssh Public Key to Ssh Public Keys of a User
  - Get All Ssh Public Keys of a User
  - Get Ssh Public Key from Ssh Public Keys of a User
  - Remove Ssh Public Key from Ssh Public Keys of a User
- Transitive Groups of User
  - Get All Transitive Groups of a User
  - Get Transitive Group from Transitive Groups of a User
- Transitive Project Roles of User
  - Get All Transitive Project Roles of a User
  - Get Transitive Project Role from Transitive Project Roles of a User
- Update Existing User
- User Details of User
  - Add User Detail to User Details of a User
  - Get All User Details of a User
  - Get User Detail from User Details of a User
  - Remove User Detail from User Details of a User

18 September 2026