oauth_authorize#

Autogenerated API

argus_api.lib.authentication.v1.oauth.oauth_authorize.authorize(responseType: str = None, clientID: str = None, redirectURI: str = None, state: str = None, nonce: str = None, scope: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Request authorization to a OAuth client (INTERNAL)

Parameters
  • responseType (list) – Type of response requested.

  • clientID (str) – The clientID of the requesting client.

  • redirectURI (str) – The redirectURI requested by the client.

  • state (str) – The state submitted by the client. This state should follow unmodified back to the redirect response after a valid client authorization.

  • nonce (str) – A nonce requested by the client. The nonce should pass through unmodified and follow the token issued for this request.

  • scope (list) – The scopes requested by the client. If ‘openid’ is in scope, this is an OpenID request.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.oauth.oauth_authorize.create_o_auth2_client(shortName: str = None, name: str = None, description: str = None, domain: str = None, customer: str = None, mainURI: str = None, redirectURIs: str = None, requiredFunction: str = None, permissionScope: str = None, authenticationMethod: str = None, clientSecret: str = None, clientIPRange: str = None, redirectURI: str = None, openIDCustomClaims: dict = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

DEPRECATED : create_o_auth2_client is an alias for create_oauth2_client. Exists only for backward compatibility - do not use - use create_oauth2_client instead.

argus_api.lib.authentication.v1.oauth.oauth_authorize.create_oauth2_client(shortName: str = None, name: str = None, description: str = None, domain: str = None, customer: str = None, mainURI: str = None, redirectURIs: str = None, requiredFunction: str = None, permissionScope: str = None, authenticationMethod: str = None, clientSecret: str = None, clientIPRange: str = None, redirectURI: str = None, openIDCustomClaims: dict = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Define a new OAuth2 client (PUBLIC)

Parameters
  • shortName (str) – [a-zA-Z0-9_:\-.]*

  • name (str) – [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • description (str) – [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • domain (str) –

  • customer (str) –

  • mainURI (str) – Sanitize by regex https://.*

  • redirectURIs (list) – Sanitize by regex http(s)?://.*

  • requiredFunction (str) –

  • permissionScope (str) –

  • authenticationMethod (str) –

  • clientSecret (str) –

  • clientIPRange (list) – format:ip

  • redirectURI (str) –

  • openIDCustomClaims (list) – Optional custom claims configuration. See documentation for valid configuration format per custom claim.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.oauth.oauth_authorize.delete_oauth2_client(idOrShortname: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Delete a OAuth2 client (PUBLIC)

Parameters
  • idOrShortname (str) – ID or shortname of client to delete

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.oauth.oauth_authorize.get_oauth2_client(idOrShortname: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Fetch a OAuth2 client descriptor (PUBLIC)

Parameters
  • idOrShortname (str) – ID or shortname of client to fetch

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.oauth.oauth_authorize.get_token(json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Exchange a OAuth2 authorization code with an access token (PUBLIC)

Parameters
  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.oauth.oauth_authorize.get_user_info(json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Return OpenID userinfo (PUBLIC)

Parameters
  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.oauth.oauth_authorize.list_oauth2_clients(customer: str = None, domain: str = None, keywords: str = None, sortBy: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

List available OAuth2 client descriptors (PUBLIC)

Parameters
  • customer (list) – Limit results to clients for this customer (or subcustomers)

  • domain (list) – Limit results to clients for this domain

  • keywords (list) – Limit results to clients matching these keywords

  • sortBy (list) – Specify sort order

  • limit (int) – Limit number of results

  • offset (int) – Skip a number of results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.oauth.oauth_authorize.post_user_info(json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Return OpenID userinfo (PUBLIC)

Parameters
  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.oauth.oauth_authorize.search_oauth2_clients(customer: str = None, domain: str = None, requiredFunction: str = None, subCriteria: dict = None, keywords: str = None, keywordMatchStrategy: str = None, keywordFieldStrategy: str = None, sortBy: str = None, limit: int = 25, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Search available OAuth2 client descriptors (PUBLIC)

Parameters
  • customer (list) – Match clients bound to any of these customers (by id or shortname)

  • domain (list) – Match clients bound to any of these domains (by id or shortname)

  • requiredFunction (list) – Match clients having any of the specified functions (id or shortname) as requiredFunction

  • subCriteria (list) – Subcriteria for this search request

  • keywords (list) – Match clients by these keywords

  • keywordMatchStrategy (str) – Search based on all keywords (AND), or based on any keyword (OR) (default Match all keywords (AND))

  • keywordFieldStrategy (list) – Which fields will be searched for the given keyword (default All supported fields)

  • sortBy (list) – Specify sort order (default shortName)

  • limit (int) – Limit the number of results (default 25)

  • offset (int) – Skip the first results, in sort order (default 0)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.oauth.oauth_authorize.update_o_auth2_client(idOrShortname: str, shortName: str = None, name: str = None, description: str = None, mainURI: str = None, redirectURIs: str = None, requiredFunction: str = None, permissionScope: str = None, authenticationMethod: str = None, clientSecret: str = None, clientIPRange: str = None, redirectURI: str = None, openIDCustomClaims: dict = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

DEPRECATED : update_o_auth2_client is an alias for update_oauth2_client. Exists only for backward compatibility - do not use - use update_oauth2_client instead.

argus_api.lib.authentication.v1.oauth.oauth_authorize.update_oauth2_client(idOrShortname: str, shortName: str = None, name: str = None, description: str = None, mainURI: str = None, redirectURIs: str = None, requiredFunction: str = None, permissionScope: str = None, authenticationMethod: str = None, clientSecret: str = None, clientIPRange: str = None, redirectURI: str = None, openIDCustomClaims: dict = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) dict#

Update an existing OAuth2 client (PUBLIC)

Parameters
  • idOrShortname (str) – ID or shortname of OAuth2 client to update

  • shortName (str) – [a-zA-Z0-9_:\-.]*

  • name (str) – [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • description (str) – [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • mainURI (str) – Sanitize by regex https://.*

  • redirectURIs (list) – Sanitize by regex http(s)?://.*

  • requiredFunction (str) –

  • permissionScope (str) –

  • authenticationMethod (str) –

  • clientSecret (str) –

  • clientIPRange (list) – format:ip

  • redirectURI (str) –

  • openIDCustomClaims (list) – If set, overwrite any existing custom claims configuration. This would remove any existing providers. Use empty array to remove all existing providers.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON