YM REST Services

<back to all web services

OAuthClientApps

Requires Authentication
Requires the role:admin
The following routes are available for this service:
GET/Ams/{ClientID}/OAuthClientApps/Generate/{KeyType}Return an OAuth client app.
GET/Ams/{ClientID}/OAuthClientAppsReturn an OAuth client app.
POST/Ams/{ClientID}/OAuthClientAppsCreate an OAuth client app.
PUT/Ams/{ClientID}/OAuthClientAppsUpdate an OAuth client app.
DELETE/Ams/{ClientID}/OAuthClientAppsDelete an OAuth client app.
OAuthClientApps Parameters:
NameParameterData TypeRequiredDescription
AppIDbodyintNo
ClientAppbodyOAuthClientAppNo
KeyTypepathKeyTypesNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
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
OAuthClientAppsResponse Parameters:
NameParameterData TypeRequiredDescription
ClientAppListformList<ClientApp>No
KeyValueformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /Ams/{ClientID}/OAuthClientApps HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"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-01T00:00:00.0000000","Modified":"0001-01-01T00:00:00.0000000","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":"2025-01-15T09:06:47.6539999-05:00","Device":"Desktop"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ClientAppList":[{"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-01T00:00:00.0000000","Modified":"0001-01-01T00:00:00.0000000","Redirects":[{"RedirectID":0,"RedirectUrl":"String"}],"IsExternal":false}],"KeyValue":"String","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-01T00:00:00.0000000","Modified":"0001-01-01T00:00:00.0000000","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":"2025-01-15T09:06:47.6641676-05:00","Device":"Desktop"}