Allows management of Third Party Application Permissions. API Reference

Allows the management of application permission that are used for 3rd party API access.

API Endpoint
https://app.memberzone.org
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0

Paths

Applications

Returns a list of all applications.

GET /api/applications

Returns a list of all applications.

200 OK
ApplicationCollectionItemModel

The list of applications.

type
ApplicationCollectionItemModel
401 Unauthorized

The user is not authorized to access this operation.

Response Example (200 OK) 
[
  {
    "ApplicationId": "integer",
    "Name": "string",
    "VendorName": "string",
    "SupportedAuthentication": "string",
    "IsApiKeySupported": "boolean",
    "IsOAuthSupported": "boolean",
    "Description": "string",
    "Actions": "string"
  }
]
Applications

Save an Application.

POST /api/applications

Saves a new Application with the model information provided.

AddEditApplicationViewModel

The application to save.

Request Example
{
  "ApplicationId": "integer",
  "Name": "string",
  "VendorId": "string",
  "VendorName": "string",
  "Description": "string",
  "WebsiteUrl": "string",
  "IsApiKeySupported": "boolean",
  "DisableIPAddressWhitelistChecking": "boolean",
  "IsGlobalApiKeySupported": "boolean",
  "GlobalApiKey": "string",
  "GlobalApiKeyIPAddressWhitelist": "string",
  "IsOAuthSupported": "boolean",
  "DisableOAuthRedirectUrlChecking": "boolean",
  "DisableOAuthConsent": "boolean",
  "IsGlobalOAuthSupported": "boolean",
  "GlobalOAuthClientId": "string",
  "GlobalOAuthClientSecret": "string",
  "GlobalOAuthRedirectUrls": "string",
  "ApiKeyInfoJson": "string",
  "GlobalPermissionApiKeyInfoJson": "string",
  "OAuthClientInfoJson": "string",
  "GlobalPermissionOAuthClientInfoJson": "string"
}
200 OK
ApplicationCollectionItemModel

The application model that was saved.

Response Example (200 OK) 
{
  "ApplicationId": "integer",
  "Name": "string",
  "VendorName": "string",
  "SupportedAuthentication": "string",
  "IsApiKeySupported": "boolean",
  "IsOAuthSupported": "boolean",
  "Description": "string",
  "Actions": "string"
}
Applications

Return an application

GET /api/applications/{applicationid}

Returns an Application by it's ID.

applicationid: integer
in path

The ID of the application return.

200 OK
AddEditApplicationViewModel

The Application model.

401 Unauthorized

The user is not authorized to access this operation.

Response Example (200 OK) 
{
  "ApplicationId": "integer",
  "Name": "string",
  "VendorId": "string",
  "VendorName": "string",
  "Description": "string",
  "WebsiteUrl": "string",
  "IsApiKeySupported": "boolean",
  "DisableIPAddressWhitelistChecking": "boolean",
  "IsGlobalApiKeySupported": "boolean",
  "GlobalApiKey": "string",
  "GlobalApiKeyIPAddressWhitelist": "string",
  "IsOAuthSupported": "boolean",
  "DisableOAuthRedirectUrlChecking": "boolean",
  "DisableOAuthConsent": "boolean",
  "IsGlobalOAuthSupported": "boolean",
  "GlobalOAuthClientId": "string",
  "GlobalOAuthClientSecret": "string",
  "GlobalOAuthRedirectUrls": "string",
  "ApiKeyInfoJson": "string",
  "GlobalPermissionApiKeyInfoJson": "string",
  "OAuthClientInfoJson": "string",
  "GlobalPermissionOAuthClientInfoJson": "string"
}
Applications

Delete an Application.

DELETE /api/applications/{applicationid}

Delete an Application.

applicationid: integer
in path

The ID of the application to delete.

200 OK

The ID of the application that was deleted.

401 Unauthorized

The user is not authorized to access this operation.

Applications

Reset a API Key.

POST /api/applications/{applicationid}/resetapikey

Resets the API secret of the client application that is assigned the ID that is provided.

applicationid: integer
in path

The ID of the client application to reset the API key for.

200 OK

The ID of the application that had it's API secret reset.

Applications

Reset a global OAuth Client Secret.

POST /api/applications/{applicationid}/resetoauthclientsecret

Resets the OAuth Client Secret of the client application that is assigned the ID that is provided.

applicationid: integer
in path

The ID of the client application to reset the OAuth Client Secret for.

200 OK

The ID of the application that had it's OAuth Client Secret reset.

Applications

Check the duplication applications based on the name.

POST /api/applications/duplicatecheck

Check the duplication applications based on the name.

AddEditApplicationViewModel

The model that contains the information to test for duplicates.

Request Example
{
  "ApplicationId": "integer",
  "Name": "string",
  "VendorId": "string",
  "VendorName": "string",
  "Description": "string",
  "WebsiteUrl": "string",
  "IsApiKeySupported": "boolean",
  "DisableIPAddressWhitelistChecking": "boolean",
  "IsGlobalApiKeySupported": "boolean",
  "GlobalApiKey": "string",
  "GlobalApiKeyIPAddressWhitelist": "string",
  "IsOAuthSupported": "boolean",
  "DisableOAuthRedirectUrlChecking": "boolean",
  "DisableOAuthConsent": "boolean",
  "IsGlobalOAuthSupported": "boolean",
  "GlobalOAuthClientId": "string",
  "GlobalOAuthClientSecret": "string",
  "GlobalOAuthRedirectUrls": "string",
  "ApiKeyInfoJson": "string",
  "GlobalPermissionApiKeyInfoJson": "string",
  "OAuthClientInfoJson": "string",
  "GlobalPermissionOAuthClientInfoJson": "string"
}
200 OK
PotentialDuplicateEntry

The list of potential duplicates.

type
PotentialDuplicateEntry
Response Example (200 OK) 
[
  {
    "Id": "integer",
    "Name": "string",
    "Description": "string"
  }
]
Applications

Search for an application name.

GET /api/applications/search

Returns a list of applications that match the search text.

this[]: string
in query

(no description)

length: string
in query

(no description)

200 OK
ApplicationViewModel

The application model.

type
ApplicationViewModel
401 Unauthorized

The user is not authorized to access this operation.

Response Example (200 OK) 
[
  {
    "ApplicationId": "integer",
    "Name": "string",
    "VendorId": "integer",
    "VendorName": "string",
    "IsGlobal": "boolean"
  }
]
Applications

Search for an application name.

GET /api/applications/search/api

Returns a list of applications that match the search text.

this[]: string
in query

(no description)

length: string
in query

(no description)

200 OK
ApplicationViewModel

The application model.

type
ApplicationViewModel
401 Unauthorized

The user is not authorized to access this operation.

Response Example (200 OK) 
[
  {
    "ApplicationId": "integer",
    "Name": "string",
    "VendorId": "integer",
    "VendorName": "string",
    "IsGlobal": "boolean"
  }
]
Applications

Search for an application name.

GET /api/applications/search/oauth

Returns a list of applications that match the search text.

this[]: string
in query

(no description)

length: string
in query

(no description)

200 OK
ApplicationViewModel

The application model.

type
ApplicationViewModel
401 Unauthorized

The user is not authorized to access this operation.

Response Example (200 OK) 
[
  {
    "ApplicationId": "integer",
    "Name": "string",
    "VendorId": "integer",
    "VendorName": "string",
    "IsGlobal": "boolean"
  }
]

Schema Definitions

ApplicationCollectionItemModel: object

ApplicationId: integer
Name: string
VendorName: string
SupportedAuthentication: string
IsApiKeySupported: boolean
IsOAuthSupported: boolean
Description: string
Actions: string
Example
{
  "ApplicationId": "integer",
  "Name": "string",
  "VendorName": "string",
  "SupportedAuthentication": "string",
  "IsApiKeySupported": "boolean",
  "IsOAuthSupported": "boolean",
  "Description": "string",
  "Actions": "string"
}

AddEditApplicationViewModel: object

ApplicationId: integer
Name: string
VendorId: string
VendorName: string
Description: string
WebsiteUrl: string
IsApiKeySupported: boolean
DisableIPAddressWhitelistChecking: boolean
IsGlobalApiKeySupported: boolean
GlobalApiKey: string
GlobalApiKeyIPAddressWhitelist: string
IsOAuthSupported: boolean
DisableOAuthRedirectUrlChecking: boolean
DisableOAuthConsent: boolean
IsGlobalOAuthSupported: boolean
GlobalOAuthClientId: string
GlobalOAuthClientSecret: string
GlobalOAuthRedirectUrls: string
ApiKeyInfoJson: string
GlobalPermissionApiKeyInfoJson: string
OAuthClientInfoJson: string
GlobalPermissionOAuthClientInfoJson: string
Example
{
  "ApplicationId": "integer",
  "Name": "string",
  "VendorId": "string",
  "VendorName": "string",
  "Description": "string",
  "WebsiteUrl": "string",
  "IsApiKeySupported": "boolean",
  "DisableIPAddressWhitelistChecking": "boolean",
  "IsGlobalApiKeySupported": "boolean",
  "GlobalApiKey": "string",
  "GlobalApiKeyIPAddressWhitelist": "string",
  "IsOAuthSupported": "boolean",
  "DisableOAuthRedirectUrlChecking": "boolean",
  "DisableOAuthConsent": "boolean",
  "IsGlobalOAuthSupported": "boolean",
  "GlobalOAuthClientId": "string",
  "GlobalOAuthClientSecret": "string",
  "GlobalOAuthRedirectUrls": "string",
  "ApiKeyInfoJson": "string",
  "GlobalPermissionApiKeyInfoJson": "string",
  "OAuthClientInfoJson": "string",
  "GlobalPermissionOAuthClientInfoJson": "string"
}

PotentialDuplicateEntry: object

Id: integer
Name: string
Description: string
Example
{
  "Id": "integer",
  "Name": "string",
  "Description": "string"
}

Object: object

Example
"object"

IHttpActionResult: object

Example
"object"

ApplicationViewModel: object

ApplicationId: integer
Name: string
VendorId: integer
VendorName: string
IsGlobal: boolean
Example
{
  "ApplicationId": "integer",
  "Name": "string",
  "VendorId": "integer",
  "VendorName": "string",
  "IsGlobal": "boolean"
}
Documentation by Spectacle