| Requires the role: | admin |
| GET | /Ams/{ClientID}/OAuthClientAppAPISetting | Return an OAuth client app API Setting. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UsingRedis | form | bool | No | |
| AppInitTime | form | DateTime | No | |
| ServerID | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ClientID | form | int | No | |
| ResponseStatus | form | ResponseStatus | No | |
| BypassCache | form | bool | No | |
| DateCached | form | DateTime | No | |
| Device | form | Device | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsAllowed | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AppID | form | int | No | |
| ClientApp | form | OAuthClientApp | No | |
| KeyType | form | KeyTypes | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MemberID | form | int | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| LogoImageContent | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AppID | form | int | No | |
| ClientAppID | form | string | No | |
| ClientAppSecret | form | string | No | |
| AppName | form | string | No | |
| CompanyName | form | string | No | |
| form | string | No | ||
| WebSiteUrl | form | string | No | |
| Description | form | string | No | |
| ContactName | form | string | No | |
| ContactNumber | form | string | No | |
| IsActive | form | bool | No | |
| ScopeApproved | form | int | No | |
| LogoImage | form | string | No | |
| Created | form | DateTime | No | |
| Modified | form | DateTime | No | |
| Redirects | form | RedirectCollection | No | |
| IsExternal | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RedirectID | form | int | No | |
| RedirectUrl | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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,
NeedUserAuthorization: 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-11-16T04:32:37.5065982-05:00,
Device: Desktop
}