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 {operation}
  • Post Idpfulldataload
  • Post Idprefreshconnectioninfo
  • Post Resolve
  • Post Schedule
  • Post Schedule
  • Post Strength
  • Post TestLogin
  • Update Existing Auth Module
• Certificates
  • Create New Certificate
  • Delete Existing Certificate
  • Get All Certificates
  • Get Certificate
  • Get QueryAssist
  • Update Existing Certificate
• Dashboards
  • Create New Dashboard
  • Delete Existing Dashboard
  • Get All Dashboards
  • Get Dashboard
  • Get QueryAssist
  • Permissions of Dashboard
    • Add Permission to Permissions of a Dashboard
    • Get All Permissions of a Dashboard
    • Get Permission from Permissions of a Dashboard
    • Remove Permission from Permissions of a Dashboard
  • Post Order
  • Update Existing Dashboard
• Events
  • Get All Events
  • Get Event
  • Get QueryAssist
• Hub Features
  • Get All Hub Features
  • Get Enabled
  • Get Hub Feature
  • Update Existing Hub Feature
• JSON Scheme
• Jobs
  • Get {id}
  • Get All Jobs
  • Get Job
• 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 Metric
  • Post DumpDiagnostics
• Migrations
  • Delete Existing Migration
  • Get All Migrations
  • Update Existing Migration
• Organization Roles
  • Get All Organization Roles
  • Get Organization Role
  • Get QueryAssist
• Organizations
  • Create New Organization
  • Delete Existing Organization
  • Get All Organizations
  • Get Icon
  • Get Organization
  • Get QueryAssist
  • Groups of Organization
    • Add Group to Groups of a Organization
    • Get All Groups of a Organization
    • Get Group from Groups of a Organization
    • Remove Group from Groups of a Organization
  • Organization Roles of Organization
    • Get All Organization Roles of a Organization
    • Get Organization Role from Organization Roles of a Organization
  • Own Users of Organization
    • Add Own User to Own Users of a Organization
    • Get All Own Users of a Organization
    • Get Own User from Own Users of a Organization
    • Remove Own User from Own Users of a Organization
  • Projects of Organization
    • Add Project to Projects of a Organization
    • Get All Projects of a Organization
    • Get Project from Projects of a Organization
    • Remove Project from Projects of a Organization
  • Teams of Organization
    • Add Team to Teams of a Organization
    • Get All Teams of a Organization
    • Get Team from Teams of a Organization
    • Remove Team from Teams of a Organization
  • Update Existing Organization
  • Users of Organization
    • Add User to Users of a Organization
    • Get All Users of a Organization
    • Get User from Users of a Organization
    • Remove User from Users of a Organization
• 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 Helpdesk Settingses
  • Get All Project Helpdesk Settingses
  • Get Project Helpdesk Settings
  • Get QueryAssist
  • Reporters of Project Helpdesk Settings
    • Add Reporter to Reporters of a Project Helpdesk Settings
    • Get All Reporters of a Project Helpdesk Settings
    • Get Reporter from Reporters of a Project Helpdesk Settings
    • Remove Reporter from Reporters of a Project Helpdesk Settings
  • Update Existing Project Helpdesk Settings
• Project Roles
  • Get All Project Roles
  • Get Project Role
  • Get QueryAssist
• Project Teams
  • Get All Project Teams
  • Get Project Team
  • Get QueryAssist
  • Groups of Project Team
    • Add Group to Groups of a Project Team
    • Get All Groups of a Project Team
    • Get Group from Groups of a Project Team
    • Remove Group from Groups of a Project Team
  • Own Users of Project Team
    • Add Own User to Own Users of a Project Team
    • Get All Own Users of a Project Team
    • Get Own User from Own Users of a Project Team
    • Remove Own User from Own Users of a Project Team
  • Post Absorb
  • Project Roles of Project Team
    • Add Project Role to Project Roles of a Project Team
    • Get All Project Roles of a Project Team
    • Get Project Role from Project Roles of a Project Team
    • Remove Project Role from Project Roles of a Project Team
  • Update Existing Project Team
  • Users of Project Team
    • Add User to Users of a Project Team
    • Get All Users of a Project Team
    • Get User from Users of a Project Team
    • Remove User from Users of a Project Team
• Projects
  • Create New Project
  • Delete Existing Project
  • Get All Projects
  • Get Global
  • Get Icon
  • Get Icon
  • Get Project
  • Get QueryAssist
  • Post Merge
  • Resources of Project
    • Add Resource to Resources of a Project
    • Get All Resources of a Project
    • Get Resource from Resources of a Project
    • Remove Resource from Resources of a Project
  • 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
• Resources
  • Create New Resource
  • Delete Existing Resource
  • Get All Resources
  • Get QueryAssist
  • Get Resource
  • Update Existing Resource
• 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
  • Organization Roles of Service
    • Add Organization Role to Organization Roles of a Service
    • Get All Organization Roles of a Service
    • Get Organization Role from Organization Roles of a Service
    • Remove Organization Role from Organization Roles of a 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
  • Resources of Service
    • Add Resource to Resources of a Service
    • Get All Resources of a Service
    • Get Resource from Resources of a Service
    • Remove Resource from Resources 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
  • Get All Settings
  • Get Liveness
  • Get QueryAssist
  • Get Readiness
  • Get Settings
  • Get Startup
• Settings
  • Create New Setting
  • Delete Existing Setting
  • Get All Settings
  • Get Locales
  • Get QueryAssist
  • Get Setting
  • Get Translation
  • Post BackupData
  • Post Message
  • Post Reset
  • Post Test
  • Update Existing Setting
• User Dashboards
  • Get All User Dashboards
  • Get QueryAssist
  • Get User Dashboard
• User Details
  • Create New User Detail
  • Delete Existing User Detail
  • Get All User Details
  • 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 Mixed
  • Get Mixed QueryAssist
  • Get QueryAssist
  • Get Root
  • Get User Group
  • Organization Roles of User Group
    • Add Organization Role to Organization Roles of a User Group
    • Get All Organization Roles of a User Group
    • Get Organization Role from Organization Roles of a User Group
    • Remove Organization Role from Organization Roles of a 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 Organization Roles of User Group
    • Get All Sourced Organization Roles of a User Group
    • Get Sourced Organization Role from Sourced Organization 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 Organization Roles of User Group
    • Get All Transitive Organization Roles of a User Group
    • Get Transitive Organization Role from Transitive Organization Roles 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
  • 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
• 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
  • Organization Roles of User
    • Add Organization Role to Organization Roles of a User
    • Get All Organization Roles of a User
    • Get Organization Role from Organization Roles of a User
    • Remove Organization Role from Organization Roles 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 Organization Roles of User
    • Get All Sourced Organization Roles of a User
    • Get Sourced Organization Role from Sourced Organization Roles 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 Organization Roles of User
    • Get All Transitive Organization Roles of a User
    • Get Transitive Organization Role from Transitive Organization Roles 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
• Widgets
  • Get All Widgets
  • Get QueryAssist
  • Get Widget