openid_provider#

Autogenerated API

argus_api.lib.authentication.v1.openid.openid_provider.add_open_id_provider(shortName: Optional[str] = None, name: Optional[str] = None, clientID: Optional[str] = None, customer: Optional[str] = None, certificate: Optional[str] = None, providerURI: Optional[str] = None, claimsMapping: Optional[dict] = None, responseType: Optional[str] = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: dict = {}, server_url: Optional[str] = None, body: Optional[dict] = None) → dict#

Define new OpenID provider (DEV)

Parameters

  • shortName (str) – Set a shortname for this provider => [a-zA-Z0-9_\-.]*

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

  • clientID (str) – The OAuth ClientID of this provider

  • customer (str) – The id or shortname of the customer this provider is bound to

  • certificate (str) – A valid X509 certificate which can be used to verify OpenID tokens

  • providerURI (str) – The URI to redirect to to initiate OpenID authentication flow => ((https?|ftp|gopher|telnet|file):((/)|(\))+[wd:\#@%/;$()~_?\+-=\.&]*)

  • claimsMapping (dict) –

  • responseType (str) – Define response type to request from provider (default idToken)

  • 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.

Raises
Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.openid.openid_provider.delete_open_id_provider(idOrShortname: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: dict = {}, server_url: Optional[str] = None, body: Optional[dict] = None) → dict#

Delete OpenID provider (DEV)

Parameters

  • idOrShortname (str) – ID or shortname of provider 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.

Raises
Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.openid.openid_provider.get_open_id_provider(idOrShortname: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: dict = {}, server_url: Optional[str] = None, body: Optional[dict] = None) → dict#

Fetch OpenID provider (DEV)

Parameters

  • idOrShortname (str) – ID or shortname of provider 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.

Raises
Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.openid.openid_provider.list_open_id_providers(customer: Optional[str] = None, keywords: Optional[str] = None, sortBy: Optional[str] = None, limit: int = 25, offset: Optional[int] = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: dict = {}, server_url: Optional[str] = None, body: Optional[dict] = None) → dict#

List OpenID providers (DEV)

Parameters

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

  • keywords (list) – Limit results to providers 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.

Raises
Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.openid.openid_provider.open_id_authentication(provider: str, idToken: Optional[str] = None, requestedAuthorizations: Optional[str] = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: dict = {}, server_url: Optional[str] = None, body: Optional[dict] = None) → dict#

Submit OpenID token for validation to create a new user session (DEV)

Parameters

  • provider (str) – ID or shortname of OpenID provider

  • idToken (str) – ID token from provider

  • requestedAuthorizations (list) – Allow client to request authorizations as part of the authentication transaction. The client is not guaranteed to get the requested authorizations. The setPassword authorization is only returned if the current user has the FORCE_PW_CHANGE flag set.

  • 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.

Raises
Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.openid.openid_provider.open_id_pre_authentication(provider: str, state: Optional[str] = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: dict = {}, server_url: Optional[str] = None, body: Optional[dict] = None) → dict#

Request redirect URI to OpenID provider (DEV)

Parameters

  • provider (str) – ID or shortname of OpenID provider

  • state (str) – State to retain

  • 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.

Raises

  • InvalidArgumentException – on 412

  • ArgusException – on other status codes

Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.openid.openid_provider.search_open_id_providers(customer: Optional[str] = None, keywords: Optional[str] = None, sortBy: Optional[str] = None, limit: int = 25, offset: Optional[int] = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: dict = {}, server_url: Optional[str] = None, body: Optional[dict] = None) → dict#

Search OpenID providers (DEV)

Parameters

  • customer (list) – Limit result by customer ID or shortname

  • keywords (list) – Match providers by keywords

  • 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.

Raises
Returns

dictionary translated from JSON

argus_api.lib.authentication.v1.openid.openid_provider.update_open_id_provider(idOrShortname: str, shortName: Optional[str] = None, name: Optional[str] = None, clientID: Optional[str] = None, certificate: Optional[str] = None, providerURI: Optional[str] = None, responseType: Optional[str] = None, claimsMapping: Optional[dict] = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: dict = {}, server_url: Optional[str] = None, body: Optional[dict] = None) → dict#

Update OpenID provider (DEV)

Parameters

  • idOrShortname (str) – ID or shortname of provider to update

  • shortName (str) – If set, update the shortname for this provider => [a-zA-Z0-9_\-.]*

  • name (str) – If set, update the name for this provider => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • clientID (str) – If set, update the OAuth ClientID for this provider

  • certificate (str) – If set, update the X509 certificate for this provider

  • providerURI (str) – If set, update the URI for this provider => ((https?|ftp|gopher|telnet|file):((/)|(\))+[wd:\#@%/;$()~_?\+-=\.&]*)

  • responseType (str) – If set, update the response type to request from provider

  • claimsMapping (dict) –

  • 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.

Raises
Returns

dictionary translated from JSON