 |
Qorus Integration Engine® Enterprise Edition 6.1.0_prod
|
|
Qorus Integration Engine® Enterprise Edition 6.1.0_prod
|
The APIs documented here do not require any authentication to access.
/schema/qorus-rest-api-public.yaml and /schema/qorus-rest-api-public.json (ex: if Qorus is available on https://localhost:8011, then the dynamic schema can be retrieved from https://localhost:8011/schema/qorus-rest-api-public.yaml and https://localhost:8011/schema/qorus-rest-api-public.json).This URI path provides access to public data provider application functionality
search (*string): a substring or regular expression search value to look for in the application name and description fieldssearch_regex (*bool): if True then any search value will be assumed to be a regular expression instead of a substringThis URI path provides access to public data provider application functionality
name (string): the unique application namedisplay_name (string): the dispay name for the applicationshort_desc (string): the application's short description in plain textdesc (string): the application description with markdown formattingbuiltin (bool): if the application is builtin to Qorus or notscheme (*string): any scheme identifying a connection for the applicationlogo (string): a link to the logo data that will be served directlylogo_file_name (string): the file name of the logologo_mime_type (string): the mime type for logo oauth2_clients (*list<OAuth2AppClientInfo>): OAuth2 client info, if anyconnections (*list<string>): a list of existing connections with the given scheme actions (*list<DataProviderActionInfo>): list of all actions on each applicationoauth2_client (*OAuth2ClientInfo): OAuth2 client info, if anyoauth2_client_id (string): the OAuth2 client ID to useoauth2_client_secret (string): the OAuth2 client secret to useurl_type (string): auto: automatically generated or required: the user must provide a URLoauth2_auth_url (*string): if set, this overrides the REST connection optionoauth2_token_url (*string): if set, this overrides the REST connection optionrequired_options (*list<string>): a list of connection options that must be filled in by the user to create the connectionContent-Type as the logo's MIME typeThis URI path provides access to public data provider application functionality
Content-Type as the logo's MIME typeThis URI path implements token-based user authentication.
instance-key (string): Qorus instance identifieromq-version (string): Qorus executable versionomq-build (string): Qorus executable git hashqore-version (string): Qore library versionomq-schema (string): Qorus system schema infonoauth (bool): An indicator if authorization is required or not; if True then the Qorus instance has authentication disabled and does not require any authentication info to connect; all API calls run with implicit internal system privileges. If False then authentication is required and enforced for all external API calls requiring authenticationedition (string): Enterprise for Qorus Integration Engine(R) Enterprise Editiontz_region (string): the time zone region the server is running intz_utc_offset (int): the UTC offset in seconds east of UTC; negative numbers indicate west of UTCThis URI path implements token-based user authentication.
user (string): The username to log inpass (string): The user's passwordtoken (string): A valid access token to be used in the Qorus-Token header in subsequent requests400 Bad Request: invalid or missing arguments401 Unauthorized: authentication failedThis URI path implements token-based user authentication.
This URI path handles requests related to OAuth2 authorization code requests
response_type (string): the response type, must be one of token or code client_id (string): required for access tokens and authorization codesredirect_uri (*string): the redirect URIcode (*string): required for an access token requestscope (*string): optional scope; OAuth2 scopes are equivalent to Qorus permissions; if empty then all scopes are assumed; if the client requests a scope / permission not allocated to the client, then an error will be returned; if scopes are provided in the call, then they must be provided as a space-separated list of scopes / permissionsstate (*string): optional statecode (*string): required if response_type is code access_token (string): the access tokentoken_type (string): the token typeexpires_in (*int): the lifetime of the token in secondsscope (*string): the scope of the responsestate (*string): the state value from the request, if any400 Bad Request: invalid or missing argumentsThis URI path handles redirect requests from OAuth2 authorization_code grant flows directly on the local Qorus instance
code (string): the authorization code to use to acquire an access tokenstate (string): this is an encrypted string generated by Qorus that contains the context information that allows the original user to be authenticated and the connection to be updated307 Temporary Redirect response is returned if successful using the redirect_uri value as the redirection location400 Bad Request: invalid or missing arguments401 Unauthorized: invalid authentication context in state, user has no right to modify user connectionsThis URI path handles requests related to OAuth2 tokens
authorization_code, password, client_credentials, refresh_token grant_type (string): the grant type; one of: authorization_code, password, client_credentials, or refresh_token redirect_uri (*string): the redirect URIcode (*string): required for an access token requestclient_id (*string): required for an access token requestscope (*string): optional scopestate (*string): optional stateusername (*string): required for an access token requestpassword (*string): required for an access token requestrefresh_token (*string): required for a refresh token requestcode (*string): required if response_type is code access_token (string): the access tokentoken_type (string): the token typeexpires_in (*int): the lifetime of the token in secondsscope (*string): the scope of the responsestate (*string): the state value from the request, if any400 Bad Request: invalid or missing argumentsThis URI path handles requests related to finalizing OAuth2 connections in authorization code grant flows
access_token (string): the access token provided by the authorization server; will set the token option on the connectionauth_context (string): encrypted authorization information for the Qorus user executing the requestconn (string): the name of the user connection to updateredirect_uri (string): the final redirect URI to be issued after a successful operationrefresh_token (*string): any refresh token provided by the authorization server; will set the oauth2_refresh_token option on the connection307 Temporary Redirect response is returned if successful using the redirect_uri value as the redirection location400 Bad Request: invalid or missing arguments401 Unauthorized: invalid authentication context in auth_context, no right to modify user connections