Authlete
DeviceAuthorizationRequest Class Reference

Request to Authlete's /api/device/authorization API. More...

Properties

string Parameters [get, set]
 Device authorization request parameters which the device authorization endpoint of the authorization server implementation received from a client application. More...
 
string ClientId [get, set]
 The client ID extracted from the Authorization header of a device authorization request from a client application. More...
 
string ClientSecret [get, set]
 The client secret extracted from the Authorization header of the device authorization request from the client application. More...
 
string ClientCertificate [get, set]
 The client certificate used in the TLS connection between the client application and the device authorization endpoint of the authorization server. More...
 
string[] ClientCertificatePath [get, set]
 The certificate path presented by the client during client authentication. More...
 

Detailed Description

Request to Authlete's /api/device/authorization API.

When the implementation of the device authorization endpoint of the authorization server receives a device authorization request from a client application, the first step is to call Authlete's /api/device/authorization API. The API will parse the device authorization request on behalf of the implementation of the device authorization endpoint.

Since version 1.5.0.

Property Documentation

◆ ClientCertificate

string ClientCertificate
getset

The client certificate used in the TLS connection between the client application and the device authorization endpoint of the authorization server.

◆ ClientCertificatePath

string [] ClientCertificatePath
getset

The certificate path presented by the client during client authentication.

Each element in the array is a certificate in PEM format.

◆ ClientId

string ClientId
getset

The client ID extracted from the Authorization header of a device authorization request from a client application.

If the device authorization endpoint of the authorization server supports Basic Authentication as a means of client authentication, and if the request from the client application contained its client ID in the Authorization header, the value should be extracted from there and set as the value of this request parameter.

◆ ClientSecret

string ClientSecret
getset

The client secret extracted from the Authorization header of the device authorization request from the client application.

If the device authorization endpoint of the authorization server supports Basic Authentication as a means of client authentication, and if the request from the client application contained its client secret in the Authorization header, the value should be extracted from there and set as the value of this request parameter.

◆ Parameters

string Parameters
getset

Device authorization request parameters which the device authorization endpoint of the authorization server implementation received from a client application.

The value of this property should be the entire request body (which is formatted in application/x-www-form-urlencoded) of the request from the client application.


The documentation for this class was generated from the following file: