# Module `netapp_ontap.resources.security_oauth2`

Copyright © 2023 NetApp Inc. All rights reserved.

This file has been automatically generated based on the ONTAP REST API documentation.

## Overview

This API is used to retrieve and delete the OAuth 2.0 configuration in the cluster. The GET request retrieves the OAuth 2.0 configuration. The DELETE request removes the OAuth 2.0 configuration. Various responses are shown in the examples below.

## Examples

### Retrieving the OAuth 2.0 configuration in the cluster

The following output shows the OAuth 2.0 configuration in the cluster.

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import SecurityOauth2

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = SecurityOauth2(name="auth0")
        resource.get()
        print(resource)

Try it out

    SecurityOauth2(
        {
            "client_id": "client_id",
            "jwks": {
                "provider_uri": "https://examplelab.customer.com/pf/JWKS",
                "refresh_interval": "PT1H",
            },
            "outgoing_proxy": "https://johndoe:secretpass@proxy.example.com:8080",
            "issuer": "https://examplelab.customer.com",
            "audience": "aud",
            "remote_user_claim": "user_claim",
            "introspection": {
                "interval": "PT1H",
                "endpoint_uri": "https://examplelab.customer.com/server/endpoint",
            },
            "hashed_client_secret": "a019c4d5f3815b50f5e9267d3ee80e8d8008308b83705c57206a1f5984dd0b26",
            "_links": {
                "self": {"href": "/api/security/authentication/cluster/oauth2/clients"}
            },
            "use_local_roles_if_present": False,
            "name": "auth0",
            "application": "http",
            "use_mutual_tls": "required",
        }
    )

### Deleting the OAuth 2.0 configuration

    from netapp_ontap import HostConnection
    from netapp_ontap.resources import SecurityOauth2

    with HostConnection("<mgmt-ip>", username="admin", password="password", verify=False):
        resource = SecurityOauth2(name="auth0")
        resource.delete()

## Classes

`class SecurityOauth2 (*args, **kwargs)`

  Allows interaction with SecurityOauth2 objects on the host

  Initialize the instance of the resource.

  Any keyword arguments are set on the instance as properties. For example, if the class was named 'MyResource', then this statement would be true:

      MyResource(name='foo').name == 'foo'

  ## Args

  `*args`
    Each positional argument represents a parent key as used in the URL of the object. That is, each value will be used to fill in a segment of the URL which refers to some parent object. The order of these arguments must match the order they are specified in the URL, from left to right.
  `**kwargs`
    each entry will have its key set as an attribute name on the instance and its value will be the value of that attribute.

  ### Ancestors

  - Resource

  ### Static methods

  `def count_collection (*args, connection: HostConnection = None, **kwargs) -> int`

    Returns a count of all SecurityOauth2 resources that match the provided query

    This calls GET on the object to determine the number of records. It is more efficient than calling get_collection() because it will not construct any objects. Query parameters can be passed in as kwargs to determine a count of objects that match some filtered criteria.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the count of bars for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host. These query parameters can affect the count. A return_records query param will be ignored.

    ## Returns

    On success, returns an integer count of the objects of this type. On failure, returns -1.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400, or if there is no connection available to use either passed in or on the library.

  `def delete_collection (*args, records: Iterable[_ForwardRef('SecurityOauth2')] = None, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> NetAppResponse`

    Deletes the OAuth 2.0 configuration with the specified name.

    ### Required properties

        * <code>config\_name</code>

    ### Related ONTAP commands

    - `security oauth2 client delete`

    ### Learn more

    - `DOC /security/authentication/cluster/oauth2/clients/{name}`

    Delete all objects in a collection which match the given query.

    All records on the host which match the query will be deleted.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to delete the collection of bars for a particular foo, the foo.name value should be passed.
    `records`
      Can be provided in place of a query. If so, this list of objects will be deleted from the host.
    `body`
      The body of the delete request. This could be a Resource instance or a dictionary object.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be deleted.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  `def fast_get_collection (*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[RawResource]`

    Returns a list of RawResources that represent SecurityOauth2 resources that match the provided query

    Fetch a list of all objects of this type from the host.

        This is a lazy fetch, making API calls only as necessary when the result
        of this call is iterated over. For instance, if max_records is set to 5,
        then iterating over the collection causes an API call to be sent to the
        server once for every 5 records. If the client stops iterating before
        getting to the 6th record, then no additional API calls are made.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `max_records`
      The maximum number of records to return per call
    `raw`
      return a list of `netapp_ontap.resource.RawResource` objects that require to be promoted before any RESTful operations can be used on them. Setting this argument to True makes get_collection substantially quicker when many records are returned from the server.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A list of `Resource` objects

    ## Raises

    `NetAppRestError`: If there is no connection available to use either passed in or on the library. This would be not be raised when get_collection() is called, but rather when the result is iterated.

  `def find (*args, connection: HostConnection = None, **kwargs) -> Resource`

    Retrieves all OAuth 2.0 configurations.

    ### Related ONTAP commands

    - `security oauth2 client show`

    ### Learn more

    - `DOC /security/authentication/cluster/oauth2/clients`

    Find an instance of an object on the host given a query.

    The host will be queried with the provided key/value pairs to find a matching resource. If 0 are found, None will be returned. If more than 1 is found, an error will be raised or returned. If there is exactly 1 matching record, then it will be returned.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to find a bar for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A `Resource` object containing the details of the object or None if no matches were found.

    ## Raises

    `NetAppRestError`: If the API call returned more than 1 matching resource.

  `def get_collection (*args, connection: HostConnection = None, max_records: int = None, **kwargs) -> Iterable[Resource]`

    Retrieves all OAuth 2.0 configurations.

    ### Related ONTAP commands

    - `security oauth2 client show`

    ### Learn more

    - `DOC /security/authentication/cluster/oauth2/clients`

    Fetch a list of all objects of this type from the host.

        This is a lazy fetch, making API calls only as necessary when the result
        of this call is iterated over. For instance, if max_records is set to 5,
        then iterating over the collection causes an API call to be sent to the
        server once for every 5 records. If the client stops iterating before
        getting to the 6th record, then no additional API calls are made.

    ## Args

    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to get the collection of bars for a particular foo, the foo.name value should be passed.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `max_records`
      The maximum number of records to return per call
    `raw`
      return a list of `netapp_ontap.resource.RawResource` objects that require to be promoted before any RESTful operations can be used on them. Setting this argument to True makes get_collection substantially quicker when many records are returned from the server.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A list of `Resource` objects

    ## Raises

    `NetAppRestError`: If there is no connection available to use either passed in or on the library. This would be not be raised when get_collection() is called, but rather when the result is iterated.

  `def post_collection (records: Iterable[_ForwardRef('SecurityOauth2')], *args, hydrate: bool = False, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, connection: HostConnection = None, **kwargs) -> Union[List[SecurityOauth2], NetAppResponse]`

    Creates the OAuth 2.0 configuration.

    ### Required properties

    - `name`
    - `application`
    - `issuer`

    ### Optional properties

    - `audience`
    - `client_id`
    - `client_secret`
    - `introspection.endpoint_uri`
    - `introspection.interval`
    - `remote_user_claim`
    - `jwks.provider_uri`
    - `jwks.refresh_interval`
    - `outgoing_proxy`
    - `use_local_roles_if_present`
    - `skip_uri_validation`
    - `use_mutual_tls`

    ### Related ONTAP commands

    - `security oauth2 client create`

    ### Learn more

    - `DOC /security/authentication/cluster/oauth2/clients`

    Send this collection of objects to the host as a creation request.

    ## Args

    `records`
      A list of `Resource` objects to send to the server to be created.
    `*args`
      Each entry represents a parent key which is used to build the path to the child object. If the URL definition were /api/foos/{foo.name}/bars, then to create a bar for a particular foo, the foo.name value should be passed.
    `hydrate`
      If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of each object. When hydrate is set to True, poll must also be set to True.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host. Only resources matching this query will be patched.

    ## Returns

    A list of `Resource` objects matching the provided type which have been created by the host and returned. This is not the same list that was provided, so to continue using the object, you should save this list. If poll is set to False, then a `NetAppResponse` object is returned instead.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  ### Methods

  `def delete (self, body: Union[Resource, dict] = None, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse`

    Deletes the OAuth 2.0 configuration with the specified name.

    ### Required properties

        * <code>config\_name</code>

    ### Related ONTAP commands

    - `security oauth2 client delete`

    ### Learn more

    - `DOC /security/authentication/cluster/oauth2/clients/{name}`

    Send a deletion request to the host for this object.

    ## Args

    `body`
      The body of the delete request. This could be a Resource instance or a dictionary object.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will be sent as query parameters to the host.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  `def get (self, **kwargs) -> NetAppResponse`

    Retrieves the OAuth 2.0 configuration with the specified name.

    ### Related ONTAP commands

    - `security oauth2 client show`

    ### Learn more

    - `DOC /security/authentication/cluster/oauth2/clients/{name}`

    Fetch the details of the object from the host.

    Requires the keys to be set (if any). After returning, new or changed properties from the host will be set on the instance.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  `def post (self, hydrate: bool = False, poll: bool = True, poll_interval: Optional[int] = None, poll_timeout: Optional[int] = None, **kwargs) -> NetAppResponse`

    Creates the OAuth 2.0 configuration.

    ### Required properties

    - `name`
    - `application`
    - `issuer`

    ### Optional properties

    - `audience`
    - `client_id`
    - `client_secret`
    - `introspection.endpoint_uri`
    - `introspection.interval`
    - `remote_user_claim`
    - `jwks.provider_uri`
    - `jwks.refresh_interval`
    - `outgoing_proxy`
    - `use_local_roles_if_present`
    - `skip_uri_validation`
    - `use_mutual_tls`

    ### Related ONTAP commands

    - `security oauth2 client create`

    ### Learn more

    - `DOC /security/authentication/cluster/oauth2/clients`

    Send this object to the host as a creation request.

    ## Args

    `hydrate`
      If set to True, after the response is received from the call, a a GET call will be made to refresh all fields of the object.
    `poll`
      If set to True, the call will not return until the asynchronous job on the host has completed. Has no effect if the host did not return a job response.
    `poll_interval`
      If the operation returns a job, this specifies how often to query the job for updates.
    `poll_timeout`
      If the operation returns a job, this specifies how long to continue monitoring the job's status for completion.
    `connection`
      The `HostConnection` object to use for this API call. If unset, tries to use the connection which is set globally for the library or from the current context.
    `**kwargs`
      Any key/value pairs passed will normally be sent as query parameters to the host. If any of these pairs are parameters that are sent as formdata then only parameters of that type will be accepted and all others will be discarded.

    ## Returns

    A `NetAppResponse` object containing the details of the HTTP response.

    ## Raises

    `NetAppRestError`: If the API call returned a status code >= 400

  ### Inherited members

  - `Resource`:
    - `from_dict`
    - `get_collection_url`
    - `get_connection`
    - `instance_location`
    - `path_keys`
    - `poll`
    - `set_connection`
    - `to_dict`
`class SecurityOauth2Schema (*, only: Union[Sequence[str], Set[str]] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Dict = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: str = None)`

  The fields of the SecurityOauth2 object

  ### Ancestors

  - netapp_ontap.resource.ResourceSchema
  - marshmallow.schema.Schema
  - marshmallow.base.SchemaABC

  ### Class variables

  `application: str GET POST`

    The name of the application using OAuth 2.0. Required for POST operations.

    Valid choices:

    - http
  `audience: str GET POST`

    The OAuth 2.0 Audience.

  `client_id: str GET POST`

    The OAuth 2.0 client ID. Required in POST operations for remote introspection.

  `client_secret: str POST`

    The OAuth 2.0 client secret. Required in POST operations for remote introspection.

  `hashed_client_secret: str GET`

    The OAuth 2.0 client secret as a SHA256 HMAC hashed value created with the cluster UUID as its HMAC secret key.

  `introspection: SecurityOauth2Introspection GET POST`

    The introspection field of the security_oauth2.

  `issuer: str GET POST`

    The OAuth 2.0 Issuer.

    Example: https://examplelab.customer.com

  `jwks: SecurityOauth2Jwks GET POST`

    The jwks field of the security_oauth2.

  `links: SelfLink GET`

    The links field of the security_oauth2.

  `name: str GET POST`

    The configuration name. Required for POST operations.

    Example: auth0

  `outgoing_proxy: str GET POST`

    Outgoing proxy to access external identity providers (IdPs). If not specified, no proxy is configured.

    Example: https://johndoe:secretpass@proxy.example.com:8080

  `remote_user_claim: str GET POST`

    The remote user claim.

  `skip_uri_validation: bool POST`

    Indicates whether or not to validate the input URIs. Default value is false.

  `use_local_roles_if_present: bool GET POST`

    Indicates whether or not to use locally confgiured roles, if present. Default value is false.

  `use_mutual_tls: str GET POST`

    OAuth 2.0 mutual TLS authentication setting. Set this value to "none" to disable mutual TLS authentication. Set this value to "required" to enforce mutual TLS authentication for all access tokens and reject any token that does not have x5t#S256 property in the cnf section. The default value is "request" which means mutual TLS authentication is enforced only if the x5t#S256 property is present in the cnf section of the access token.

    Valid choices:

    - none
    - request
    - required