# OAuth2Client

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_token_strategy** | Option<**String**> | OAuth 2.0 Access Token Strategy  AccessTokenStrategy is the strategy used to generate access tokens. Valid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token Setting the strategy here overrides the global setting in `strategies.access_token`. | [optional]
**allowed_cors_origins** | Option<**Vec<String>**> | OAuth 2.0 Client Allowed CORS Origins  One or more URLs (scheme://host[:port]) which are allowed to make CORS requests to the /oauth/token endpoint. If this array is empty, the server's CORS origin configuration (`CORS_ALLOWED_ORIGINS`) will be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration. Be aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work. | [optional]
**audience** | Option<**Vec<String>**> | OAuth 2.0 Client Audience  An allow-list defining the audiences this client is allowed to request tokens for. An audience limits the applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list of URLs. URLs MUST NOT contain whitespaces. | [optional]
**authorization_code_grant_access_token_lifespan** | Option<**String**> |  | [optional]
**authorization_code_grant_id_token_lifespan** | Option<**String**> |  | [optional]
**authorization_code_grant_refresh_token_lifespan** | Option<**String**> |  | [optional]
**backchannel_logout_session_required** | Option<**bool**> | OpenID Connect Back-Channel Logout Session Required  Boolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout Token to identify the RP session with the OP when the backchannel_logout_uri is used. If omitted, the default value is false. | [optional]
**backchannel_logout_uri** | Option<**String**> | OpenID Connect Back-Channel Logout URI  RP URL that will cause the RP to log itself out when sent a Logout Token by the OP. | [optional]
**client_credentials_grant_access_token_lifespan** | Option<**String**> |  | [optional]
**client_id** | Option<**String**> | OAuth 2.0 Client ID  The ID is immutable. If no ID is provided, a UUID4 will be generated. | [optional]
**client_name** | Option<**String**> | OAuth 2.0 Client Name  The human-readable name of the client to be presented to the end-user during authorization. | [optional]
**client_secret** | Option<**String**> | OAuth 2.0 Client Secret  The secret will be included in the create request as cleartext, and then never again. The secret is kept in hashed format and is not recoverable once lost. | [optional]
**client_secret_expires_at** | Option<**i64**> | OAuth 2.0 Client Secret Expires At  The field is currently not supported and its value is always 0. | [optional]
**client_uri** | Option<**String**> | OAuth 2.0 Client URI  ClientURI is a URL string of a web page providing information about the client. If present, the server SHOULD display this URL to the end-user in a clickable fashion. | [optional]
**contacts** | Option<**Vec<String>**> | OAuth 2.0 Client Contact  An array of strings representing ways to contact people responsible for this client, typically email addresses. | [optional]
**created_at** | Option<**String**> | OAuth 2.0 Client Creation Date  CreatedAt returns the timestamp of the client's creation. | [optional]
**device_authorization_grant_access_token_lifespan** | Option<**String**> |  | [optional]
**device_authorization_grant_id_token_lifespan** | Option<**String**> |  | [optional]
**device_authorization_grant_refresh_token_lifespan** | Option<**String**> |  | [optional]
**frontchannel_logout_session_required** | Option<**bool**> | OpenID Connect Front-Channel Logout Session Required  Boolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be included to identify the RP session with the OP when the frontchannel_logout_uri is used. If omitted, the default value is false. | [optional]
**frontchannel_logout_uri** | Option<**String**> | OpenID Connect Front-Channel Logout URI  RP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query parameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the request and to determine which of the potentially multiple sessions is to be logged out; if either is included, both MUST be. | [optional]
**grant_types** | Option<**Vec<String>**> | OAuth 2.0 Client Grant Types  An array of OAuth 2.0 grant types the client is allowed to use. Can be one of:  Client Credentials Grant: `client_credentials` Authorization Code Grant: `authorization_code` OpenID Connect Implicit Grant (deprecated!): `implicit` Refresh Token Grant: `refresh_token` OAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer` OAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code` | [optional]
**implicit_grant_access_token_lifespan** | Option<**String**> |  | [optional]
**implicit_grant_id_token_lifespan** | Option<**String**> |  | [optional]
**jwks** | Option<[**models::JsonWebKeySet**](jsonWebKeySet.md)> |  | [optional]
**jwks_uri** | Option<**String**> | OAuth 2.0 Client JSON Web Key Set URL  URL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains the signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the Client's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate. | [optional]
**jwt_bearer_grant_access_token_lifespan** | Option<**String**> |  | [optional]
**logo_uri** | Option<**String**> | OAuth 2.0 Client Logo URI  A URL string referencing the client's logo. | [optional]
**metadata** | Option<[**serde_json::Value**](.md)> |  | [optional]
**owner** | Option<**String**> | OAuth 2.0 Client Owner  Owner is a string identifying the owner of the OAuth 2.0 Client. | [optional]
**policy_uri** | Option<**String**> | OAuth 2.0 Client Policy URI  PolicyURI is a URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data. | [optional]
**post_logout_redirect_uris** | Option<**Vec<String>**> | Allowed Post-Redirect Logout URIs  Array of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the post_logout_redirect_uri parameter after a logout has been performed. | [optional]
**redirect_uris** | Option<**Vec<String>**> | OAuth 2.0 Client Redirect URIs  RedirectURIs is an array of allowed redirect urls for the client. | [optional]
**refresh_token_grant_access_token_lifespan** | Option<**String**> |  | [optional]
**refresh_token_grant_id_token_lifespan** | Option<**String**> |  | [optional]
**refresh_token_grant_refresh_token_lifespan** | Option<**String**> |  | [optional]
**registration_access_token** | Option<**String**> | OpenID Connect Dynamic Client Registration Access Token  RegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client using Dynamic Client Registration. | [optional]
**registration_client_uri** | Option<**String**> | OpenID Connect Dynamic Client Registration URL  RegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client. | [optional]
**request_object_signing_alg** | Option<**String**> | OpenID Connect Request Object Signing Algorithm  JWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects from this Client MUST be rejected, if not signed with this algorithm. | [optional]
**request_uris** | Option<**Vec<String>**> | OpenID Connect Request URIs  Array of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the contents of the files referenced by these URIs and not retrieve them at the time they are used in a request. OPs can require that request_uri values used be pre-registered with the require_request_uri_registration discovery parameter. | [optional]
**response_types** | Option<**Vec<String>**> | OAuth 2.0 Client Response Types  An array of the OAuth 2.0 response type strings that the client can use at the authorization endpoint. Can be one of:  Needed for OpenID Connect Implicit Grant: Returns ID Token to redirect URI: `id_token` Returns Access token redirect URI: `token` Needed for Authorization Code Grant: `code` | [optional]
**scope** | Option<**String**> | OAuth 2.0 Client Scope  Scope is a string containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens. | [optional]
**sector_identifier_uri** | Option<**String**> | OpenID Connect Sector Identifier URI  URL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of redirect_uri values. | [optional]
**skip_consent** | Option<**bool**> | SkipConsent skips the consent screen for this client. This field can only be set from the admin API. | [optional]
**skip_logout_consent** | Option<**bool**> | SkipLogoutConsent skips the logout consent screen for this client. This field can only be set from the admin API. | [optional]
**subject_type** | Option<**String**> | OpenID Connect Subject Type  The `subject_types_supported` Discovery parameter contains a list of the supported subject_type values for this server. Valid types include `pairwise` and `public`. | [optional]
**token_endpoint_auth_method** | Option<**String**> | OAuth 2.0 Token Endpoint Authentication Method  Requested Client Authentication method for the Token Endpoint. The options are:  `client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header. `client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body. `private_key_jwt`: Use JSON Web Tokens to authenticate the client. `none`: Used for public clients (native apps, mobile apps) which can not have secrets. | [optional][default to client_secret_basic]
**token_endpoint_auth_signing_alg** | Option<**String**> | OAuth 2.0 Token Endpoint Signing Algorithm  Requested Client Authentication signing algorithm for the Token Endpoint. | [optional]
**tos_uri** | Option<**String**> | OAuth 2.0 Client Terms of Service URI  A URL string pointing to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client. | [optional]
**updated_at** | Option<**String**> | OAuth 2.0 Client Last Update Date  UpdatedAt returns the timestamp of the last update. | [optional]
**userinfo_signed_response_alg** | Option<**String**> | OpenID Connect Request Userinfo Signed Response Algorithm  JWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT [JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims as a UTF-8 encoded JSON object using the application/json content-type. | [optional]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


