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, openIDCustomClaims: dict = None, maxSecurityLevel: str = None, hidden: bool = None, redirectURI: 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#

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, openIDCustomClaims: dict = None, maxSecurityLevel: str = None, hidden: bool = None, redirectURI: 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#

Define a new OAuth2 client (PUBLIC)

Parameters

  • shortName (str) – A shortname describing this resource. This name will show up when listing external resources. => [a-zA-Z0-9_:\-.]*

  • name (str) – A name describing this resource. This name will show up when listing external resources. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

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

  • domain (str) – Specifies the domain in which this resource is defined. The user must have the required function for this domain. If customer is set, the customer must be defined in this domain. If this field is not set, it defaults to the current users domain.

  • customer (str) – Specifying a customer will restrict this resource to a specific customer. This will limit access to this resource to users having the required function for this specific customer. The resource clients delegated session will also be constrained to this particular customer. If customer is not specified, access to this resource will be given to users having the requiredFunction for any customer.

  • mainURI (str) – The main landing page for this resource. This will be used to link to the application from Argus. => Sanitize by regex https://.*

  • redirectURIs (list) – The redirect URIs to allow when redirecting from the OAuth authorization endpoint. => Sanitize by regex http(s)?://.*

  • requiredFunction (str) – The function (id or name) required to grant access to this resource. If customer is specified, this function is required for that particular customer.

  • permissionScope (str) – The function/role (id or name) to constrain the delegated client session to, restricting what the resource client will be allowed to do on behalf of the user. The delegated client session will be constrained to the least set of the users current session permissions, and this role.

  • authenticationMethod (str) – The authentication method required for this client. Default is password.

  • clientSecret (str) – If authenticationMethod is password, the password must be provided in the clientSecret parameter.

  • clientIPRange (list) – A list of CIDR IP ranges which the client will be permitted from. => format:ip

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

  • maxSecurityLevel (str) – Max security level for this client (default external)

  • hidden (bool) – If true, this client is by default excluded in the oauth external client list

  • redirectURI (str) – DEPRECATED: This field is DEPRECATED. Use redirectURIs instead.

  • 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(includeFlags: str = None, customer: str = None, domain: str = None, requiredFunction: str = None, subCriteria: dict = None, keywords: str = None, keywordMatchStrategy: str = None, keywordFieldStrategy: str = None, excludeFlags: 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

  • includeFlags (list) – Include clients having all these flags

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

  • excludeFlags (list) – Exclude clients having any of these flags

  • 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, openIDCustomClaims: dict = None, maxSecurityLevel: str = None, hidden: bool = None, redirectURI: 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#

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, openIDCustomClaims: dict = None, maxSecurityLevel: str = None, hidden: bool = None, redirectURI: 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#

Update an existing OAuth2 client (PUBLIC)

Parameters

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

  • shortName (str) – If set, update the shortname describing this resource. This name will show up when listing external resources. => [a-zA-Z0-9_:\-.]*

  • name (str) – If set, update the name describing this resource. This name will show up when listing external resources. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

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

  • mainURI (str) – If set, update the main landing page for this resource. This will be used to link to the application from Argus. => Sanitize by regex https://.*

  • redirectURIs (list) – If set, update the redirect URIs to allow when redirecting from the OAuth authorization endpoint. => Sanitize by regex http(s)?://.*

  • requiredFunction (str) – If set, change the function (id or name) required to grant access to this resource. If customer is specified, this function is required for that particular customer.

  • permissionScope (str) – If set, change the function/role (id or name) to constrain the delegated client session to, restricting what the resource client will be allowed to do on behalf of the user. The delegated client session will be constrained to the least set of the users current session permissions, and this role.

  • authenticationMethod (str) – If set, change the authentication method required for this client.

  • clientSecret (str) – If set, update the client secret of this OAuth2 client. If changing authenticationMethod to password, the password must be provided in this clientSecret parameter.

  • clientIPRange (list) – If set, change the CIDR IP ranges which the client will be permitted from. => format:ip

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

  • maxSecurityLevel (str) – If set, change the max security level for this client

  • hidden (bool) – If set, change the value of the ‘hidden’ flag on this client. A hidden client is by default excluded from the oauth client application list.

  • redirectURI (str) – DEPRECATED: This field is DEPRECATED. Use redirectURIs instead.

  • 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