Authlete API. More...

Inheritance diagram for IAuthleteApi:

Public Member Functions
Task< AuthorizationResponse >	Authorization (AuthorizationRequest request)
	Call Authlete's `/api/auth/authorization` API. More...

Task< AuthorizationFailResponse >	AuthorizationFail (AuthorizationFailRequest request)
	Call Authlete's `/api/auth/authorization/fail` API. More...

Task< AuthorizationIssueResponse >	AuthorizationIssue (AuthorizationIssueRequest request)
	Call Authlete's `/api/auth/authorization/issue` API. More...

Task< TokenResponse >	Token (TokenRequest request)
	Call Authlete's `/api/auth/token` API. More...

Task< TokenCreateResponse >	TokenCreate (TokenCreateRequest request)
	Call Authlete's `/api/auth/token/create` API. More...

Task< object >	TokenDelete (string token)
	Delete an access token (= call Authlete's `/api/auth/token/delete/{token}` API). More...

Task< TokenFailResponse >	TokenFail (TokenFailRequest request)
	Call Authlete's `/api/auth/token/fail` API. More...

Task< TokenIssueResponse >	TokenIssue (TokenIssueRequest request)
	Call Authlete's `/api/auth/token/issue` API. More...

Task< TokenUpdateResponse >	TokenUpdate (TokenUpdateRequest request)
	Call Authlete's `/api/auth/token/update` API. More...

Task< RevocationResponse >	Revocation (RevocationRequest request)
	Call Authlete's `/api/auth/revocation` API. More...

Task< UserInfoResponse >	UserInfo (UserInfoRequest request)
	Call Authlete's `/api/auth/userinfo` API. More...

Task< UserInfoIssueResponse >	UserInfoIssue (UserInfoIssueRequest request)
	Call Authlete's `/api/auth/userinfo/issue` API. More...

Task< IntrospectionResponse >	Introspection (IntrospectionRequest request)
	Call Authlete's `/api/auth/introspection` API. More...

Task< StandardIntrospectionResponse >	StandardIntrospection (StandardIntrospectionRequest request)
	Call Authlete's `/api/auth/introspection/standard` API. More...

Task< Service >	CreateService (Service service)
	Create a service (= call Authlete's `/api/service/create` API). More...

Task< object >	DeleteService (long apiKey)
	Delete a service (call Authlete's `/api/service/delete/{apiKey}` API). More...

Task< Service >	GetService (long apiKey)
	Get information about a service (= call Authlete's `/api/service/get/{apiKey}` API). More...

Task< ServiceListResponse >	GetServiceList ()
	Get a list of services that belong to the service owner (= call Authlete's `/api/service/get/list` API). More...

Task< ServiceListResponse >	GetServiceList (int start, int end)
	Get a list of services that belong to the service owner (= call Authlete's `/api/service/get/list` API). More...

Task< Service >	UpdateService (Service service)
	Update a service (= call Authlete's `/api/service/update/{apiKey}` API). More...

Task< string >	GetServiceJwks ()
	Get the JWK Set of a service (= call Authlete's `/api/service/jwks/get` API). More...

Task< string >	GetServiceJwks (bool pretty, bool includePrivateKeys)
	Get the JWK Set of a service (= call Authlete's `/api/service/jwks/get` API). More...

Task< string >	GetServiceConfiguration ()
	Get the configuration of the service in JSON format that complies with OpenID Connect Discovery 1.0. More...

Task< string >	GetServiceConfiguration (bool pretty)
	Get the configuration of the service in JSON format that complies with OpenID Connect Discovery 1.0 (= call Authlete's `/api/service/configuration` API). More...

Task< Client >	CreateClient (Client client)
	Create a client (= call Authlete's `/api/client/create` API). More...

Task< object >	DeleteClient (long clientId)
	Delete a client (= call Authlete's `/api/client/delete/{clientId}` API). More...

Task< Client >	GetClient (long clientId)
	Get information about a client (= call Authlete's `/api/client/get/{clientId}` API). More...

Task< ClientListResponse >	GetClientList ()
	Get a list of clients that belong to the service (= call Authlete's `/api/client/get/list` API). More...

Task< ClientListResponse >	GetClientList (string developer)
	Get a list of clients that belong to the developer (= call Authlete's `/api/client/get/list` API). More...

Task< ClientListResponse >	GetClientList (int start, int end)
	Get a list of clients that belong to the service (= call Authlete's `/api/client/get/list` API). More...

Task< ClientListResponse >	GetClientList (string developer, int start, int end)
	Get a list of clients (= call Authlete's `/api/client/get/list` API). More...

Task< Client >	UpdateClient (Client client)
	Update a client (= call Authlete's `/api/client/update/{clientId}` API). More...

Task< GrantedScopesGetResponse >	GetGrantedScopes (long clientId, string subject)
	Get the set of scopes that an end-user has granted to a client application (= call Authlete's `/api/client/granted_scopes/get/{clientId}` API). More...

Task< ApiResponse >	DeleteGrantedScopes (long clientId, string subject)
	Delete DB records about the set of scopes that an end-user has granted to a client application (= call Authlete's `/api/client/granted_scopes/delete/{clientId}` API). More...

Task< ApiResponse >	DeleteClientAuthorization (long clientId, string subject)
	Delete all existing access tokens issued to the client application by the end-user (= call Authlete's `/api/client/authorization/delete/{clientId}` API). More...

Task< AuthorizedClientListResponse >	GetClientAuthorizationList (ClientAuthorizationGetListRequest request)
	Get the list of client applications authorized by the end-user (= call Authlete's `/api/client/authorization/get/list` API). More...

Task< ApiResponse >	UpdateClientAuthorization (long clientId, ClientAuthorizationUpdateRequest request)
	Update attributes of all existing access tokens issued to the client application by the end-user (= call Authlete's `/api/client/authorization/update/{clientId}` API). More...

Task< ClientSecretRefreshResponse >	RefreshClientSecret (long clientId)
	Refresh the client secret of a client (= call Authlete's `/api/client/secret/refresh/{clientId}` API). A new value of the client secret will be generated by the Authlete server. If you want to specify a new value, use `UpdateClientSecret` method. More...

Task< ClientSecretRefreshResponse >	RefreshClientSecret (string clientIdentifier)
	Refresh the client secret of a client (= call Authlete's `/api/client/secret/refresh/{clientId}` API). A new value of the client secret will be generated by the Authlete server. If you want to specify a new value, use `UpdateClientSecret` method. More...

Task< ClientSecretUpdateResponse >	UpdateClientSecret (long clientId, string clientSecret)
	Update the client secret of a client (= call Authlete's `/api/client/secret/update/{clientId}` API). If you want to have the Authlete server generate a new value of the client secret, use `RefreshClientSecret` method. More...

Task< ClientSecretUpdateResponse >	UpdateClientSecret (string clientIdentifier, string clientSecret)
	Update the client secret of a client (= call Authlete's `/api/client/secret/update/{clientId}` API). If you want to have the Authlete server generate a new value of the client secret, use `RefreshClientSecret` method. More...

Task< BackchannelAuthenticationResponse >	BackchannelAuthentication (BackchannelAuthenticationRequest request)
	Call Authlete's `/api/backchannel/authentication` API. More...

Task< BackchannelAuthenticationIssueResponse >	BackchannelAuthenticationIssue (BackchannelAuthenticationIssueRequest request)
	Call Authlete's `/api/backchannel/authentication/issue` API. More...

Task< BackchannelAuthenticationFailResponse >	BackchannelAuthenticationFail (BackchannelAuthenticationFailRequest request)
	Call Authlete's `/api/backchannel/authentication/fail` API. More...

Task< BackchannelAuthenticationCompleteResponse >	BackchannelAuthenticationComplete (BackchannelAuthenticationCompleteRequest request)
	Call Authlete's `/api/backchannel/authentication/complete` API. More...

Task< DeviceAuthorizationResponse >	DeviceAuthorization (DeviceAuthorizationRequest request)
	Call Authlete's `/api/device/authorization` API. More...

Task< DeviceCompleteResponse >	DeviceComplete (DeviceCompleteRequest request)
	Call Authlete's `/api/device/complete` API. More...

Task< DeviceVerificationResponse >	DeviceVerification (DeviceVerificationRequest request)
	Call Authlete's `/api/device/verification` API. More...

Task< PushedAuthReqResponse >	PushAuthorizationRequest (PushedAuthReqRequest request)
	Call Authlete's `/api/pushed_auth_req` API. More...

Properties
ISettings	Settings `[get]`
	The reference to the settings of this `IAuthleteApi` implementation. More...

Detailed Description

Authlete API.

Member Function Documentation

◆ Authorization()

Task<AuthorizationResponse> Authorization ( AuthorizationRequest request )

Call Authlete's /api/auth/authorization API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ AuthorizationFail()

Task<AuthorizationFailResponse> AuthorizationFail ( AuthorizationFailRequest request )

Call Authlete's /api/auth/authorization/fail API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ AuthorizationIssue()

Task<AuthorizationIssueResponse> AuthorizationIssue ( AuthorizationIssueRequest request )

Call Authlete's /api/auth/authorization/issue API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ BackchannelAuthentication()

Task<BackchannelAuthenticationResponse> BackchannelAuthentication ( BackchannelAuthenticationRequest request )

Call Authlete's /api/backchannel/authentication API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ BackchannelAuthenticationComplete()

Task<BackchannelAuthenticationCompleteResponse> BackchannelAuthenticationComplete ( BackchannelAuthenticationCompleteRequest request )

Call Authlete's /api/backchannel/authentication/complete API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ BackchannelAuthenticationFail()

Task<BackchannelAuthenticationFailResponse> BackchannelAuthenticationFail ( BackchannelAuthenticationFailRequest request )

Call Authlete's /api/backchannel/authentication/fail API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ BackchannelAuthenticationIssue()

Task<BackchannelAuthenticationIssueResponse> BackchannelAuthenticationIssue ( BackchannelAuthenticationIssueRequest request )

Call Authlete's /api/backchannel/authentication/issue API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ CreateClient()

Task<Client> CreateClient ( Client client )

Create a client (= call Authlete's /api/client/create API).

Returns: Information about the client that was newly created.

Parameters

client Information about the client you want to create.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ CreateService()

Task<Service> CreateService ( Service service )

Create a service (= call Authlete's /api/service/create API).

Returns: Information about the service that was newly created.

Parameters

service Information about the service you want to create.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ DeleteClient()

Task<object> DeleteClient ( long clientId )

Delete a client (= call Authlete's /api/client/delete/{clientId} API).

Parameters

clientId The client ID of the client application you want to delete.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ DeleteClientAuthorization()

Task<ApiResponse> DeleteClientAuthorization	(	long	clientId,
		string	subject
	)

Delete all existing access tokens issued to the client application by the end-user (= call Authlete's /api/client/authorization/delete/{clientId} API).

Returns: The result of the API call.

Parameters

clientId Client ID.

Parameters

subject Subject (= unique identifier) of an end-user.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ DeleteGrantedScopes()

Task<ApiResponse> DeleteGrantedScopes	(	long	clientId,
		string	subject
	)

Delete DB records about the set of scopes that an end-user has granted to a client application (= call Authlete's /api/client/granted_scopes/delete/{clientId} API).

Even if you delete records about granted scopes by calling this API, existing access tokens are not deleted and scopes of existing access tokens are not changed.

Please call this method if the end-user identified by the subject is deleted from your system. Otherwise, garbage data continue to exist in the database.

Returns: The result of the API call.

Parameters

clientId Client ID.

Parameters

subject Subject (= unique identifier) of an end-user.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ DeleteService()

Task<object> DeleteService ( long apiKey )

Delete a service (call Authlete's /api/service/delete/{apiKey} API).

Parameters

apiKey The API key of the service.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ DeviceAuthorization()

Task<DeviceAuthorizationResponse> DeviceAuthorization ( DeviceAuthorizationRequest request )

Call Authlete's /api/device/authorization API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Since version 1.5.0.

Implemented in AuthleteApi.

◆ DeviceComplete()

Task<DeviceCompleteResponse> DeviceComplete ( DeviceCompleteRequest request )

Call Authlete's /api/device/complete API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Since version 1.5.0.

Implemented in AuthleteApi.

◆ DeviceVerification()

Task<DeviceVerificationResponse> DeviceVerification ( DeviceVerificationRequest request )

Call Authlete's /api/device/verification API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Since version 1.5.0.

Implemented in AuthleteApi.

◆ GetClient()

Task<Client> GetClient ( long clientId )

Get information about a client (= call Authlete's /api/client/get/{clientId} API).

Returns: Information about the client.

Parameters

clientId The client ID.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ GetClientAuthorizationList()

Task<AuthorizedClientListResponse> GetClientAuthorizationList ( ClientAuthorizationGetListRequest request )

Get the list of client applications authorized by the end-user (= call Authlete's /api/client/authorization/get/list API).

Returns: The list of client applications.

Parameters

request Conditions of the query to Authlete's /api/client/authorization/get/list API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ GetClientList() [1/4]

Task<ClientListResponse> GetClientList ( )

Get a list of clients that belong to the service (= call Authlete's /api/client/get/list API).

This method uses the default range to limit the result set of the query. Use GetClientList(int, int) to specify the range explicitly.

Returns: A list of clients.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ GetClientList() [2/4]

Task<ClientListResponse> GetClientList	(	int	start,
		int	end
	)

Get a list of clients that belong to the service (= call Authlete's /api/client/get/list API).

Returns: A list of clients.

Parameters

start The start index (inclusive) of the result set of the query. Must not be negative.

Parameters

end	The end index (exclusive) of the result set of the query. Must not be negative.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ GetClientList() [3/4]

Task<ClientListResponse> GetClientList ( string developer )

Get a list of clients that belong to the developer (= call Authlete's /api/client/get/list API).

When developer is null, a list of client applications that belong to the service is returned.

This method uses the default range to limit the result set of the query. Use GetClientList(string, int, int) to specify the range explicitly.

Returns: A list of clients.

Parameters

developer The developer of the targeted client applications.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ GetClientList() [4/4]

Task<ClientListResponse> GetClientList	(	string	developer,
		int	start,
		int	end
	)

Get a list of clients (= call Authlete's /api/client/get/list API).

Returns: A list of clients.

When developer is null, a list of clients that belong to the service is returned. Otherwise, when developer is not null, a list of clients that belong to the developer is returned.

The pair of start and end parameters denotes the range of the result set of the query. For example, if start is 5 and end is 7, the pair makes a range from 5 (inclusive) to 7 (exclusive) and the response will contain (at most) 2 pieces of client information, i.e., information about the 6th and 7th clients (the index starts from 0).

If (end - start) is equal to or less than 0, ClientListResponse.Clients method of the response returns null. But even in such a case, ClientListResponse.TotalCount method returns the total count. In other words, if you want to get just the total count, you can write the code as shown below.

// Call /api/client/get/list API.
ClientListResponse res =
    await api.GetClientList(developer, 0, 0);
 
// Get the number of client applications.
int totalCount = res.TotalCount;

Parameters

developer The developer of the targeted clients, or null to get a list of clients of the entire sive.

Parameters

start The start index (inclusive) of the result set of the query. Must not be negative.

Parameters

end	The end index (exclusive) of the result set of the query. Must not be negative.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ GetGrantedScopes()

Task<GrantedScopesGetResponse> GetGrantedScopes	(	long	clientId,
		string	subject
	)

Get the set of scopes that an end-user has granted to a client application (= call Authlete's /api/client/granted_scopes/get/{clientId} API).

A dedicated Authlete server provides a functionality to remember the set of scopes that an end-user has granted to a client application. A remembered set is NOT removed from the database even after all existing access tokens associated with the combination of the client application and the subject have expired. Note that this functionality is not provided by the shared Authlete server.

Returns: Scopes granted to the client application by the end-user.

Parameters

clientId Client ID.

Parameters

subject Subject (= unique identifier) of an end-user.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ GetService()

Task<Service> GetService ( long apiKey )

Get information about a service (= call Authlete's /api/service/get/{apiKey} API).

Returns: Information about the service.

Parameters

apiKey The API key of the service.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ GetServiceConfiguration() [1/2]

Task<string> GetServiceConfiguration ( )

Get the configuration of the service in JSON format that complies with OpenID Connect Discovery 1.0.

This method is an alias of GetServiceConfiguration(true)

Returns: The configuration of the service in JSON format.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ GetServiceConfiguration() [2/2]

Task<string> GetServiceConfiguration ( bool pretty )

Get the configuration of the service in JSON format that complies with OpenID Connect Discovery 1.0 (= call Authlete's /api/service/configuration API).

The value returned from this method can be used as the response body from /.well-known/openid-configuration. See 4. Obtaining OpenID Provider Configuration Information of OpenID Connect Discovery 1.0 for details.

Returns: The configuration of the service in JSON format.

Parameters

pretty true to get the JSON in pretty format.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ GetServiceJwks() [1/2]

Task<string> GetServiceJwks ( )

Get the JWK Set of a service (= call Authlete's /api/service/jwks/get API).

This method is an alias of GetServiceJwks(false, false).

Returns: JSON representation of the JWK Set of the service.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ GetServiceJwks() [2/2]

Task<string> GetServiceJwks	(	bool	pretty,
		bool	includePrivateKeys
	)

Get the JWK Set of a service (= call Authlete's /api/service/jwks/get API).

Returns: JSON representation of the JWK Set of the service.

Parameters

pretty true to get the JSON in pretty format.

Parameters

includePrivateKeys true to include private keys in the JSON. false to exclude private keys from the JSON.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ GetServiceList() [1/2]

Task<ServiceListResponse> GetServiceList ( )

Get a list of services that belong to the service owner (= call Authlete's /api/service/get/list API).

This method uses the default range to limit the result set of the query. Use GetServiceList(int, int) to specify the range explicitly.

Returns: A list of services.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ GetServiceList() [2/2]

Task<ServiceListResponse> GetServiceList	(	int	start,
		int	end
	)

Get a list of services that belong to the service owner (= call Authlete's /api/service/get/list API).

The pair of start and end parameters denotes the range of the result set of the query. For example, if start is 5 and end is 7, the pair makes a range from 5 (inclusive) to 7 (exclusive) and the response will contain (at most) 2 pieces of service information, i.e., information about the 6th and the 7th services (the index starts from 0).

If (end - start) is equal to or less than 0, ServiceListResponse.Services method of the response returns null. But even in such a case, ServiceListResponse.TotalCount method returns the total count. In other words, if you want to get just the total count, you can write the code as shown below.

// Call /api/service/get/list API.
ServiceListResponse res =
    await api.GetServiceList(0, 0);
 
// Get the number of services.
int totalCount = res.TotalCount;

Returns: A list of services.

Parameters

start The start index (inclusive) of the result set of the query. Must not be negative.

Parameters

end	The end index (exclusive) of the result set of the query. Must not be negative.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ Introspection()

Task<IntrospectionResponse> Introspection ( IntrospectionRequest request )

Call Authlete's /api/auth/introspection API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ PushAuthorizationRequest()

Task<PushedAuthReqResponse> PushAuthorizationRequest ( PushedAuthReqRequest request )

Call Authlete's /api/pushed_auth_req API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Since version 1.5.0.

Implemented in AuthleteApi.

◆ RefreshClientSecret() [1/2]

Task<ClientSecretRefreshResponse> RefreshClientSecret ( long clientId )

Refresh the client secret of a client (= call Authlete's /api/client/secret/refresh/{clientId} API). A new value of the client secret will be generated by the Authlete server. If you want to specify a new value, use UpdateClientSecret method.

Returns: The client secret.

Parameters

clientId Client ID.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ RefreshClientSecret() [2/2]

Task<ClientSecretRefreshResponse> RefreshClientSecret ( string clientIdentifier )

Refresh the client secret of a client (= call Authlete's /api/client/secret/refresh/{clientId} API). A new value of the client secret will be generated by the Authlete server. If you want to specify a new value, use UpdateClientSecret method.

Returns: The client secret.

Parameters

clientIdentifier Client ID.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ Revocation()

Task<RevocationResponse> Revocation ( RevocationRequest request )

Call Authlete's /api/auth/revocation API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ StandardIntrospection()

Task<StandardIntrospectionResponse> StandardIntrospection ( StandardIntrospectionRequest request )

Call Authlete's /api/auth/introspection/standard API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ Token()

Task<TokenResponse> Token ( TokenRequest request )

Call Authlete's /api/auth/token API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ TokenCreate()

Task<TokenCreateResponse> TokenCreate ( TokenCreateRequest request )

Call Authlete's /api/auth/token/create API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ TokenDelete()

Task<object> TokenDelete ( string token )

Delete an access token (= call Authlete's /api/auth/token/delete/{token} API).

Parameters

token An access token or its hash value.

Exceptions

AuthleteApiException

Since version 1.5.0.

Implemented in AuthleteApi.

◆ TokenFail()

Task<TokenFailResponse> TokenFail ( TokenFailRequest request )

Call Authlete's /api/auth/token/fail API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ TokenIssue()

Task<TokenIssueResponse> TokenIssue ( TokenIssueRequest request )

Call Authlete's /api/auth/token/issue API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ TokenUpdate()

Task<TokenUpdateResponse> TokenUpdate ( TokenUpdateRequest request )

Call Authlete's /api/auth/token/update API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ UpdateClient()

Task<Client> UpdateClient ( Client client )

Update a client (= call Authlete's /api/client/update/{clientId} API).

client.ClientId must return the correct client ID of the client.

Returns: Information about the updated client.

Parameters

client Information about a client you want to update.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ UpdateClientAuthorization()

Task<ApiResponse> UpdateClientAuthorization	(	long	clientId,
		ClientAuthorizationUpdateRequest	request
	)

Update attributes of all existing access tokens issued to the client application by the end-user (= call Authlete's /api/client/authorization/update/{clientId} API).

Returns: The result of the API call.

Parameters

clientId Client ID.

Parameters

request Request.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ UpdateClientSecret() [1/2]

Task<ClientSecretUpdateResponse> UpdateClientSecret	(	long	clientId,
		string	clientSecret
	)

Update the client secret of a client (= call Authlete's /api/client/secret/update/{clientId} API). If you want to have the Authlete server generate a new value of the client secret, use RefreshClientSecret method.

Valid characters for a client secret are A-Z, a-z, 0-9, -, and _. The maximum length of a client secret is 86.

Returns: The client secret.

Parameters

clientId Client ID.

Parameters

clientSecret A new value of client secret.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ UpdateClientSecret() [2/2]

Task<ClientSecretUpdateResponse> UpdateClientSecret	(	string	clientIdentifier,
		string	clientSecret
	)

Update the client secret of a client (= call Authlete's /api/client/secret/update/{clientId} API). If you want to have the Authlete server generate a new value of the client secret, use RefreshClientSecret method.

Valid characters for a client secret are A-Z, a-z, 0-9, -, and _. The maximum length of a client secret is 86.

Returns: The client secret.

Parameters

clientIdentifier Client ID.

Parameters

clientSecret A new value of client secret.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ UpdateService()

Task<Service> UpdateService ( Service service )

Update a service (= call Authlete's /api/service/update/{apiKey} API).

service.ApiKey must return the correct API key of the service.

Returns: Information about the updated service.

Parameters

service Information about a service to update.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ UserInfo()

Task<UserInfoResponse> UserInfo ( UserInfoRequest request )

Call Authlete's /api/auth/userinfo API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

◆ UserInfoIssue()

Task<UserInfoIssueResponse> UserInfoIssue ( UserInfoIssueRequest request )

Call Authlete's /api/auth/userinfo/issue API.

Returns: A response from the API.

Parameters

request Request parameters passed to the API.

Exceptions

AuthleteApiException

Implemented in AuthleteApi.

Property Documentation

◆ Settings

ISettings Settings

get

The reference to the settings of this IAuthleteApi implementation.

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

Authlete/Api/IAuthleteApi.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ Authorization()

◆ AuthorizationFail()

◆ AuthorizationIssue()

◆ BackchannelAuthentication()

◆ BackchannelAuthenticationComplete()

◆ BackchannelAuthenticationFail()

◆ BackchannelAuthenticationIssue()

◆ CreateClient()

◆ CreateService()

◆ DeleteClient()

◆ DeleteClientAuthorization()

◆ DeleteGrantedScopes()

◆ DeleteService()

◆ DeviceAuthorization()

◆ DeviceComplete()

◆ DeviceVerification()

◆ GetClient()

◆ GetClientAuthorizationList()

◆ GetClientList() [1/4]

◆ GetClientList() [2/4]

◆ GetClientList() [3/4]

◆ GetClientList() [4/4]

◆ GetGrantedScopes()

◆ GetService()

◆ GetServiceConfiguration() [1/2]

◆ GetServiceConfiguration() [2/2]

◆ GetServiceJwks() [1/2]

◆ GetServiceJwks() [2/2]

◆ GetServiceList() [1/2]

◆ GetServiceList() [2/2]

◆ Introspection()

◆ PushAuthorizationRequest()

◆ RefreshClientSecret() [1/2]

◆ RefreshClientSecret() [2/2]

◆ Revocation()

◆ StandardIntrospection()

◆ Token()

◆ TokenCreate()

◆ TokenDelete()

◆ TokenFail()

◆ TokenIssue()

◆ TokenUpdate()

◆ UpdateClient()

◆ UpdateClientAuthorization()

◆ UpdateClientSecret() [1/2]

◆ UpdateClientSecret() [2/2]

◆ UpdateService()

◆ UserInfo()

◆ UserInfoIssue()

Property Documentation

◆ Settings