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

ApplicationPermission

Returns a list of all applications permissions.

GET /api/applicationpermissions/apikeys

Returns a list of all application permissions for the current tenant.

200 OK
ApiKeyApplicationPermissionCollectionItemModel

The list of applications permission for the current tenant.

type
ApiKeyApplicationPermissionCollectionItemModel
401 Unauthorized

The user is not authorized to access this operation.

Response Example (200 OK) 
[
  {
    "ApplicationPermissionId": "integer",
    "ApplicationName": "string",
    "VendorName": "string",
    "ApiKeyInfoJson": "string",
    "HasGlobalApiKey": "boolean",
    "ApiKey": "string",
    "Actions": "string"
  }
]
ApplicationPermission

Save a client application.

POST /api/applicationpermissions/apikeys/{applicationpermissionid}

Saves a client application with the model information provided.

AddEditApiKeyApplicationPermissionViewModel

The client application to save.

applicationpermissionid: integer
in path

(no description)

Request Example
{
  "ApplicationPermissionId": "integer",
  "ApplicationId": "string",
  "ApplicationName": "string",
  "IsGlobal": "boolean",
  "TenantKey": "string",
  "GlobalApiKeyIPAddressWhitelist": "string",
  "ApiKeyInfoJson": "string"
}
200 OK
ApiKeyApplicationPermissionCollectionItemModel

The client application model that was saved.

Response Example (200 OK) 
{
  "ApplicationPermissionId": "integer",
  "ApplicationName": "string",
  "VendorName": "string",
  "ApiKeyInfoJson": "string",
  "HasGlobalApiKey": "boolean",
  "ApiKey": "string",
  "Actions": "string"
}
ApplicationPermission

Delete the application permission.

DELETE /api/applicationpermissions/apikeys/{applicationpermissionid}

Delete the application permission.

applicationpermissionid: integer
in path

The ID of the application permission to delete.

200 OK

The ID of the application permission that was deleted.

401 Unauthorized

The user is not authorized to access this operation.

ApplicationPermission

Return an application permission.

GET /api/applicationpermissions/apikeys/{applicationpermissionid}

Returns an application permission by it's ID.

applicationpermissionid: integer
in path

The ID of the application permission to return.

200 OK
AddEditApiKeyApplicationPermissionViewModel

The application permission model.

401 Unauthorized

The user is not authorized to access this operation.

Response Example (200 OK) 
{
  "ApplicationPermissionId": "integer",
  "ApplicationId": "string",
  "ApplicationName": "string",
  "IsGlobal": "boolean",
  "TenantKey": "string",
  "GlobalApiKeyIPAddressWhitelist": "string",
  "ApiKeyInfoJson": "string"
}
ApplicationPermission

Reset a API Key API secret.

POST /api/applicationpermissions/apikeys/{applicationpermissionid}/resetapikey

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

applicationpermissionid: 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.

ApplicationPermission

GET /api/applicationpermissions/apikeys/checkforaccess

200 OK

OK

ApplicationPermission

Returns a list of all OAuth Client applications permissions.

GET /api/applicationpermissions/oauthclients

Returns a list of all application permissions for the current tenant.

200 OK
OAuthClientApplicationPermissionCollectionItemModel

The list of applications permission for the current tenant.

type
OAuthClientApplicationPermissionCollectionItemModel
401 Unauthorized

The user is not authorized to access this operation.

Response Example (200 OK) 
[
  {
    "ApplicationPermissionId": "integer",
    "ApplicationName": "string",
    "VendorName": "string",
    "OAuthClientInfoJson": "string",
    "HasGlobalOAuthClient": "boolean",
    "ClientId": "string",
    "ClientSecret": "string",
    "Actions": "string"
  }
]
ApplicationPermission

Save an OAuth Client application permission.

POST /api/applicationpermissions/oauthclients/{applicationpermissionid}

Saves a client application with the model information provided.

AddEditOAuthClientApplicationPermissionViewModel

The OAuth client application permission to save.

applicationpermissionid: integer
in path

(no description)

Request Example
{
  "ApplicationPermissionId": "integer",
  "ApplicationId": "string",
  "ApplicationName": "string",
  "IsGlobal": "boolean",
  "GlobalOAuthRedirectUrls": "string",
  "OAuthClientInfoJson": "string"
}
200 OK
OAuthClientApplicationPermissionCollectionItemModel

The client application model that was saved.

Response Example (200 OK) 
{
  "ApplicationPermissionId": "integer",
  "ApplicationName": "string",
  "VendorName": "string",
  "OAuthClientInfoJson": "string",
  "HasGlobalOAuthClient": "boolean",
  "ClientId": "string",
  "ClientSecret": "string",
  "Actions": "string"
}
ApplicationPermission

Delete the OAuth Client application permission.

DELETE /api/applicationpermissions/oauthclients/{applicationpermissionid}

Delete the OAuth Client application permission.

applicationpermissionid: integer
in path

The ID of the application permission to delete.

200 OK

The ID of the application permission that was deleted.

401 Unauthorized

The user is not authorized to access this operation.

ApplicationPermission

Return an OAuth Client application permission.

GET /api/applicationpermissions/oauthclients/{applicationpermissionid}

Returns an application permission by it's ID.

applicationpermissionid: integer
in path

The ID of the application permission to return.

200 OK
AddEditOAuthClientApplicationPermissionViewModel

The application permission model.

401 Unauthorized

The user is not authorized to access this operation.

Response Example (200 OK) 
{
  "ApplicationPermissionId": "integer",
  "ApplicationId": "string",
  "ApplicationName": "string",
  "IsGlobal": "boolean",
  "GlobalOAuthRedirectUrls": "string",
  "OAuthClientInfoJson": "string"
}
ApplicationPermission

Reset a Client Secret.

POST /api/applicationpermissions/oauthclients/{applicationpermissionid}/resetclientsecret

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

applicationpermissionid: integer
in path

The ID of the client application to reset the Cleint Secret for.

200 OK

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

Schema Definitions

ApiKeyApplicationPermissionCollectionItemModel: object

ApplicationPermissionId: integer
ApplicationName: string
VendorName: string
ApiKeyInfoJson: string
HasGlobalApiKey: boolean
ApiKey: string
Actions: string
Example
{
  "ApplicationPermissionId": "integer",
  "ApplicationName": "string",
  "VendorName": "string",
  "ApiKeyInfoJson": "string",
  "HasGlobalApiKey": "boolean",
  "ApiKey": "string",
  "Actions": "string"
}

AddEditApiKeyApplicationPermissionViewModel: object

ApplicationPermissionId: integer
ApplicationId: string
ApplicationName: string
IsGlobal: boolean
TenantKey: string
GlobalApiKeyIPAddressWhitelist: string
ApiKeyInfoJson: string
Example
{
  "ApplicationPermissionId": "integer",
  "ApplicationId": "string",
  "ApplicationName": "string",
  "IsGlobal": "boolean",
  "TenantKey": "string",
  "GlobalApiKeyIPAddressWhitelist": "string",
  "ApiKeyInfoJson": "string"
}

IHttpActionResult: object

Example
"object"

Object: object

Example
"object"

OAuthClientApplicationPermissionCollectionItemModel: object

ApplicationPermissionId: integer
ApplicationName: string
VendorName: string
OAuthClientInfoJson: string
HasGlobalOAuthClient: boolean
ClientId: string
ClientSecret: string
Actions: string
Example
{
  "ApplicationPermissionId": "integer",
  "ApplicationName": "string",
  "VendorName": "string",
  "OAuthClientInfoJson": "string",
  "HasGlobalOAuthClient": "boolean",
  "ClientId": "string",
  "ClientSecret": "string",
  "Actions": "string"
}

AddEditOAuthClientApplicationPermissionViewModel: object

ApplicationPermissionId: integer
ApplicationId: string
ApplicationName: string
IsGlobal: boolean
GlobalOAuthRedirectUrls: string
OAuthClientInfoJson: string
Example
{
  "ApplicationPermissionId": "integer",
  "ApplicationId": "string",
  "ApplicationName": "string",
  "IsGlobal": "boolean",
  "GlobalOAuthRedirectUrls": "string",
  "OAuthClientInfoJson": "string"
}
Documentation by Spectacle