Skip to content

Latest commit

 

History

History
23 lines (19 loc) · 2.97 KB

OAuth2Client.md

File metadata and controls

23 lines (19 loc) · 2.97 KB
Raw

OAuth2Client

Properties

Name Type Description Notes
ClientName string Name is the human-readable string name of the client to be presented to the end-user during authorization. [optional] [default to null]
ClientSecret string Secret is the client's secret. The secret will be included in the create request as cleartext, and then never again. The secret is stored using BCrypt so it is impossible to recover it. Tell your users that they need to write the secret down as it will not be made available again. [optional] [default to null]
ClientUri string ClientURI is an 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] [default to null]
Contacts []string Contacts is a array of strings representing ways to contact people responsible for this client, typically email addresses. [optional] [default to null]
GrantTypes []string GrantTypes is an array of grant types the client is allowed to use. [optional] [default to null]
Id string ID is the id for this client. [optional] [default to null]
LogoUri string LogoURI is an URL string that references a logo for the client. [optional] [default to null]
Owner string Owner is a string identifying the owner of the OAuth 2.0 Client. [optional] [default to null]
PolicyUri string 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] [default to null]
Public bool Public is a boolean that identifies this client as public, meaning that it does not have a secret. It will disable the client_credentials grant type for this client if set. [optional] [default to null]
RedirectUris []string RedirectURIs is an array of allowed redirect urls for the client, for example http://mydomain/oauth/callback . [optional] [default to null]
ResponseTypes []string ResponseTypes is an array of the OAuth 2.0 response type strings that the client can use at the authorization endpoint. [optional] [default to null]
Scope string 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] [default to null]
TosUri string TermsOfServiceURI is a URL string that points 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] [default to null]

[Back to Model list] [Back to API list] [Back to README]