OAuthClients In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:32:31 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:32:31

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IOAuthClients>() and is defined in Telligent.Evolution.Platform.dll

Properties

Name	Type	Description	Default	Options
Current	`[[OAuthClient In-Process API Supplementary Type\|OAuthClient]]`	Gets the OAuthClient for the current authenticated request. Returns null if there is no current OAuthClient.

Methods

Uri Authorize(Guid clientId, string callbackUrl, string responseType, string scope, string state);

Obsolete in 12: Use Authorize(Guid clientId,string callbackUrl,string responseType,OauthAuthorizationRequestOptions options) instead.

Parameters

Name	Type	Description	Required
clientId	`Guid`	Client Id	Required
callbackUrl	`string`	Callback url	Required
responseType	`string`	Response type	Required
scope	`string`	Scope	Required
state	`string`	State	Required

Return Type

Uri

Uri Authorize(Guid clientId, string callbackUrl, string responseType, OauthAuthorizationRequestOptions options = null);

Parameters

Name	Type	Description	Required
clientId	`Guid`	Client Id of client configured for this Oauth request.	Required
callbackUrl	`string`	Callback url assigned to the client id provided.	Required
responseType	`string`	Response type: Either code or token depending on the client type.	Required
options	`[[OauthAuthorizationRequestOptions In-Process API Supplementary Type\|OauthAuthorizationRequestOptions]]`	Additional options to support an authorization request.	Optional

Return Type

Uri

OAuthClient Get(Guid clientId);

Gets a OAuth Client

Parameters

Name	Type	Description	Required	Default	Options
clientId	`Guid`	ClientId	Required

Return Type

[[OAuthClient In-Process API Supplementary Type|OAuthClient]]