YM REST Services

<back to all web services

OAuthClientAppAPISetting

Requires Authentication
Requires the role:admin
The following routes are available for this service:
GET/Ams/{ClientID}/OAuthClientAppAPISettingReturn an OAuth client app API Setting.
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
OAuthClientAppAPISettingResponse Parameters:
NameParameterData TypeRequiredDescription
IsAllowedformboolNo
OAuthClientApps Parameters:
NameParameterData TypeRequiredDescription
AppIDformintNo
ClientAppformOAuthClientAppNo
KeyTypeformKeyTypesNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
OAuthClientApp Parameters:
NameParameterData TypeRequiredDescription
LogoImageContentformstringNo
ClientApp Parameters:
NameParameterData TypeRequiredDescription
AppIDformintNo
ClientAppIDformstringNo
ClientAppSecretformstringNo
AppNameformstringNo
CompanyNameformstringNo
EmailformstringNo
WebSiteUrlformstringNo
DescriptionformstringNo
ContactNameformstringNo
ContactNumberformstringNo
IsActiveformboolNo
ScopeApprovedformintNo
LogoImageformstringNo
CreatedformDateTimeNo
ModifiedformDateTimeNo
RedirectsformRedirectCollectionNo
IsExternalformboolNo
Redirect Parameters:
NameParameterData TypeRequiredDescription
RedirectIDformintNo
RedirectUrlformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Ams/{ClientID}/OAuthClientAppAPISetting HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	IsAllowed: False,
	AppID: 0,
	ClientApp: 
	{
		LogoImageContent: String,
		ClientID: 0,
		AppID: 0,
		ClientAppID: String,
		ClientAppSecret: String,
		AppName: String,
		CompanyName: String,
		Email: String,
		WebSiteUrl: String,
		Description: String,
		ContactName: String,
		ContactNumber: String,
		IsActive: False,
		ScopeApproved: 0,
		LogoImage: String,
		Created: 0001-01-01,
		Modified: 0001-01-01,
		Redirects: 
		[
			{
				RedirectID: 0,
				RedirectUrl: String
			}
		],
		IsExternal: False
	},
	KeyType: None,
	MemberID: 0,
	ClientID: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	BypassCache: False,
	DateCached: 2024-09-07T23:05:07.6232496-04:00,
	Device: Desktop
}