wiki:ApplicationsApi
Last modified 3 years ago Last modified on 02/24/14 15:29:38

/api/v1/apps/add

Add an application UUID/secret pair

INPUT:

  • LABEL (required) -> Label of the application
  • ALLOW_NETWORK_IPv4 (optional) -> Restrict access from the following IPv4 net
  • ALLOW_NETWORK_IPv6 (optional) -> Restrict access from the following IPv6 net
  • WRITE (optional, default False) -> Add write capabilities
  • GROUP (optional) -> Restrict authentication only to this group of users [not used now!]
  • REALM (optional) -> set alternative realm, if app has *

OUTPUT:

  • app_id -> The application ID
  • app_secret -> The Application secret

/api/v1/apps/delete

Delete an application

INPUT:

  • APP_ID -> Application ID

OUTPUT:

  • none

/api/v1/apps/info

Show the application details

INPUT:

  • APP_ID (required) -> Application ID

OUTPUT:

  • app_id -> Application ID
  • label -> Application Label (for customer use)
  • group -> Associated authorization group (empty if all allowed)
  • realm -> Primary realm of the application
  • write -> If the application can do write/update operations
  • allow_network_ipv4 -> Requests allowed from the given IPv4 Network
  • allow_network_ipv6 -> Requests allowed from the given IPv6 Network

/api/v1/apps/list

Show the list of applications

INPUT:

  • REALM (optional) -> set alternative realm, if app has *

OUTPUT:

  • APP_ID -> array of applications

/api/v1/apps/modify

Modify an Application

INPUT:

  • APP_ID -> Application ID
  • LABEL (optional) -> Label of the application
  • ALLOW_NETWORK_IPv4 (optional) -> Restrict access from the following IPv4 net
  • ALLOW_NETWORK_IPv6 (optional) -> Restrict access from the following IPv6 net
  • WRITE (optional, default False) -> Add write capabilities
  • GROUP (optional) -> Restrict authentication only to this group of users [not used now!]

OUTPUT:

  • app_id -> The application ID