Hub REST API

This section will help you learn everything you need to work with the Hub REST API.

• Hub REST API Guide
  • Log in to Hub
    • Permanent Token Authorization in Hub
    • OAuth 2.0 Authorization in Hub
      • Implicit
      • Authorization Code
      • Refresh Token
      • Resource Owner Password Credentials
      • Client Credentials
      • Extension Grants
      • OAuth 2.0 Errors
  • REST API URL and Endpoints
  • Hub OpenAPI Specification (OAS)
  • Hub API Field Syntax
  • Sort Syntax in Hub
  • Hub API Query Syntax
• Hub REST API Reference
  • 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
      • Add Authmodule to Authmodules of a Org
      • Get All Authmodules of a Org
      • Get Authmodule from Authmodules of a Org
      • Remove Authmodule from Authmodules of a Org
    • Certificates of Org
      • Add Certificate to Certificates of a Org
      • Get All Certificates of a Org
      • Get Certificate from Certificates of a Org
      • Remove Certificate from Certificates of a Org
    • Create New Org
    • Delete Existing Org
    • Get All Orgs
    • Get Org
    • Get QueryAssist
    • Keystores of Org
      • Add Keystore to Keystores of a Org
      • Get All Keystores of a Org
      • Get Keystore from Keystores of a Org
      • Remove Keystore from Keystores of a Org
    • Profile Attribute Prototypes of Org
      • Add Profile Attribute Prototype to Profile Attribute Prototypes of a Org
      • Get All Profile Attribute Prototypes of a Org
      • Get Profile Attribute Prototype from Profile Attribute Prototypes of a Org
      • Remove Profile Attribute Prototype from Profile Attribute Prototypes of a Org
    • Services of Org
      • Add Service to Services of a Org
      • Get All Services of a Org
      • Get Service from Services of a Org
      • Remove Service from Services of a Org
    • Update Existing Org
    • Userdetails of Org
      • Add Userdetail to Userdetails of a Org
      • Get All Userdetails of a Org
      • Get Userdetail from Userdetails of a Org
      • Remove Userdetail from Userdetails of a Org
    • Usergroups of Org
      • Add Usergroup to Usergroups of a Org
      • Get All Usergroups of a Org
      • Get Usergroup from Usergroups of a Org
      • Remove Usergroup from Usergroups of a Org
    • Workspaces of Org
      • Add Workspace to Workspaces of a Org
      • Get All Workspaces of a Org
      • Get Workspace from Workspaces of a Org
      • Remove Workspace from Workspaces of a 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
      • Add Permission to Permissions of a Role
      • Get All Permissions of a Role
      • Get Permission from Permissions of a Role
      • Remove Permission from Permissions of a 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
      • Add Default Role to Default Roles of a Service
      • Get All Default Roles of a Service
      • Get Default Role from Default Roles of a Service
      • Remove Default Role from Default Roles of a Service
    • Delete Existing Service
    • Get All Services
    • Get Header
    • Get QueryAssist
    • Get Service
    • Permissions of Service
      • Add Permission to Permissions of a Service
      • Get All Permissions of a Service
      • Get Permission from Permissions of a Service
      • Remove Permission from Permissions of a Service
    • Project Roles of Service
      • Add Project Role to Project Roles of a Service
      • Get All Project Roles of a Service
      • Get Project Role from Project Roles of a Service
      • Remove Project Role from Project Roles of a Service
    • Untrusted Redirect U R Is of Service
      • Add Untrusted Redirect U R I to Untrusted Redirect U R Is of a Service
      • Delete Reject
      • Get All Untrusted Redirect U R Is of a Service
      • Get Untrusted Redirect U R I from Untrusted Redirect U R Is of a Service
      • Post Accept
      • Remove Untrusted Redirect U R I from Untrusted Redirect U R Is of a Service
    • Update Existing Service
    • Viewers of Service
      • Add Viewer to Viewers of a Service
      • Get All Viewers of a Service
      • Get Viewer from Viewers of a Service
      • Remove Viewer from Viewers of a 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
      • Add Project Role to Project Roles of a User Group
      • Get All Project Roles of a User Group
      • Get Project Role from Project Roles of a User Group
      • Remove Project Role from Project Roles of a 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
      • Add Subgroup to Subgroups of a User Group
      • Get All Subgroups of a User Group
      • Get Subgroup from Subgroups of a User Group
      • Remove Subgroup from Subgroups of a 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
      • Add Updater to Updaters of a User Group
      • Get All Updaters of a User Group
      • Get Updater from Updaters of a User Group
      • Remove Updater from Updaters of a User Group
    • Users of User Group
      • Add User to Users of a User Group
      • Get All Users of a User Group
      • Get User from Users of a User Group
      • Remove User from Users of a User Group
    • Viewers of User Group
      • Add Viewer to Viewers of a User Group
      • Get All Viewers of a User Group
      • Get Viewer from Viewers of a User Group
      • Remove Viewer from Viewers of a 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