Kaa releases
Shortcuts
Skip to end of metadata
Go to start of metadata

User

Get user authentication status

Returns information about the current authorized user.

  • URL 
    /kaaAdmin/rest/api/auth/checkAuth
  • Method:
    GET

  • URL params

    None

  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create user with KAA_ADMIN role

Creates a user with the KAA_ADMIN role.

  • URL 
    /kaaAdmin/rest/api/auth/createKaaAdmin?username&password
  • Method:
    POST

  • URL params

    ParameterValueDescription
    usernamestringA user name of the Kaa admin user
    passwordstringA user password of the Kaa admin user; it must be no shorter than 6 characters
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    403 ForbiddenA user with the KAA_ADMIN role already exists
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

Change user password

Changes the password of a user.

  • URL 
    /kaaAdmin/rest/api/auth/changePassword?username&oldPassword&newPassword
  • Method:
    POST

  • URL params

    ParameterValueDescription
    usernamestringA user name of the user whose password is to be changed
    oldPasswordstringAn old password of the user
    newPasswordstringA new password of the user; it must be no shorter than 6 characters
  • Data params

    None

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    400 Bad RequestThe specified parameters are not valid
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get user profile

Returns the user profile of the current user. Only authorized users are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/userProfile
  • Method:
    GET

  • URL params

    None

  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Edit user profile

Edits the user profile. Only authorized users are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/userProfile
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

 

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get all users

Returns a list of all users associated with the current authorized user: users whose Tenant ID values match the Tenant ID of the request submitter. Only users with the TENANT_ADMIN role are allowed to submit this request.

  • URL 
    /kaaAdmin/rest/api/users
  • Method:
    GET

  • URL params

    None

  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_ADMIN)
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get user

 Returns a user. Only users with the TENANT_ADMIN role are allowed to submit this request. The Tenant ID of requested user must be identical to the Tenant ID of the submitter.

  • URL 
    /kaaAdmin/rest/api/user/{userId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    userIdstringThe user ID of the requested user
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_ADMIN) or the Tenant ID of the requested user does not match the Tenant ID of the authenticated user
    404 Not FoundThe user with the specified userId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit user

Creates or edits a user. If a user with the specified ID does not exist, it will be created, and its Tenant ID will be set to the Tenant ID of the request submitter. A random password will be generated and sent to the user’s Email. If a user with the specified ID exists, the user will be updated. Only users with the TENANT_ADMIN role can perform this operation.

  • URL 
    /kaaAdmin/rest/api/user
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_ADMIN) or the Tenant ID of the editing user does not match the Tenant ID of the authenticated user
    404 Not FoundThe user to be edited with the specified userId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call to create user:

     Example result
  • Sample call to edit user:

     Example result

Tenant

Get all tenants

Returns all tenants existing in the system. Only Kaa admin is allowed to submit this request.

  • URL 
    /kaaAdmin/rest/api/tenants
  • Method:
    GET

  • URL params

    None

  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the KAA_ADMIN role
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get tenant

Returns tenant by associated userId.

  • URL 
    /kaaAdmin/rest/api/tenant/{userId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    userIdstringThe ID of the user associated with the requested tenant
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the KAA_ADMIN role
    404 Not FoundA tenant with the specified userId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit tenant

Creates or edits a tenant. If a tenant with the specified ID does not exist, it will be created. If a tenant with the specified ID exists, it will be updated.

  • URL 
    /kaaAdmin/rest/api/tenant
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the KAA_ADMIN role
    404 Not FoundA tenant with the specified userId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call to create tenant:

     Example result
  • Sample call to edit tenant:

     Example result

Delete tenant

Deletes a tenant by associated User ID.

  • URL 
    /kaaAdmin/rest/api/delTenant?userId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    userIdstringThe ID of the user associated with the tenant to be deleted
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the  KAA_ADMIN role
    404 Not FoundA tenant with the specified userId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

Application

Get all applications

Returns all applications for the current authorized user within the current tenant. The current user must have one of the following roles: TENANT_ADMIN, TENANT_DEVELOPER, or TENANT_USER.

  • URL 
    /kaaAdmin/rest/api/applications
  • Method:
    GET

  • URL params

    None

  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_ADMIN, TENANT_DEVELOPER, or TENANT_USER)
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get application

Returns an application by application ID.

 

As of release 0.9.0 this method is deprecated, replaced by Get application by it's token.

 

  • URL 
    /kaaAdmin/rest/api/application/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringThe ID of the application
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_ADMIN, TENANT_DEVELOPER, or TENANT_USER) or Tenant ID of the application does not match the Tenant ID of the user
    404 Not FoundAn application with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get application by its token

Returns an application by applicationToken

  • URL 
    /kaaAdmin/rest/api/application/token/{applicationToken}
  • Method: 
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringThe token of the application
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_ADMIN, TENANT_DEVELOPER, or TENANT_USER) or Tenant ID of the application does not match the Tenant ID of the user
    404 Not FoundAn application with the specified applicationToken does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit application

Creates or edits an application. If the application with the specified ID does not exist, it will be created. If the application with the specified ID exists, it will be updated. Only users with the TENANT_ADMIN role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/application
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_ADMIN) or the Tenant ID of the application to be edited does not match the Tenant ID of the user
    404 Not FoundAn application to be edited with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call to create application:

     Example result
  • Sample call to edit application:

     Example result

Common Type Library

Create CTL schema

Creates a CTL schema. Only authorized users are allowed to perform this operation.

As of release 0.9.0 this method is deprecated, replaced by Create CTL schema with application token.

  • URL
    /kaaAdmin/rest/api/CTL/saveSchema
  • Method: 
    POST

  • URL params

    ParameterValueDescription
    bodystringThe CTL schema structure
    tenantIdstringThe ID of the tenant
    applicationIdstringThe ID of the application
  • Data params

    None

  • Success response:

    • Code: 200
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    400 Bad RequestThe CTL schema body provided is invalid
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe Tenant ID of the CTL schema does not match the Tenant ID of the authenticated user
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create CTL schema with application token

Creates a CTL schema with application token. Only authorized users are allowed to perform this operation.

  • URL
    /kaaAdmin/rest/api/CTL/appToken/saveSchema
  • Method: 
    POST

  • URL params

    ParameterValueDescription
    bodystringThe CTL schema structure
    tenantIdstringThe ID of the tenant
    applicationTokenstringThe token of the application
  • Data params

    None

  • Success response:

    • Code: 200
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    400 Bad RequestThe CTL schema body provided is invalid
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe Tenant ID of the CTL schema does not match the Tenant ID of the authenticated user
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Delete CTL schema

Deletes a CTL schema. Only authorized users are allowed to perform this operation.

As of release 0.9.0 this method is deprecated, replaced by Delete CTL schema with application token.

  • URL 
    /kaaAdmin/rest/api/CTL/deleteSchema?fqn={fqn}&version={version}&tenantId={tenantId}&applicationId={applicationId}
  • Method: 
    POST

  • URL params

    ParameterValueDescription
    fqnstringThe fully qualified name of the CTL schema
    versionintegerThe version number of the CTL schema
    tenantIdstringThe ID of the tenant
    applicationIdstringThe ID of the application
  • Data params

    None

  • Success response:

     

    • Code: 200 

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe Tenant ID of the CTL schema does not match the Tenant ID of the authenticated user
    404 Not FoundA CTL schema with the specified fully qualified name, version number, tenant and application identifiers does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

Delete CTL schema with application token

Deletes a CTL schema with application token. Only authorized users are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/CTL/appToken/deleteSchema?fqn={fqn}&version={version}&tenantId={tenantId}&applicationToken={applicationToken}
  • Method: 
    POST

  • URL params

    ParameterValueDescription
    fqnstringThe fully qualified name of the CTL schema
    versionintegerThe version number of the CTL schema
    tenantIdstringThe ID of the tenant
    applicationTokenstringThe token of the application
  • Data params

    None

  • Success response:

     

    • Code: 200 

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe Tenant ID of the CTL schema does not match the Tenant ID of the authenticated user
    404 Not FoundA CTL schema with the specified fully qualified name, version number, tenant and application identifiers does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

Get CTL schema

 Returns a CTL schema. Only authorized users are allowed to perform this operation.

As of release 0.9.0 this method is deprecated, replaced by Get CTL schema with application token.

  • URL 
    /kaaAdmin/rest/api/CTL/getSchema?fqn={fqn}&version={version}&tenantId={tenantId}&applicationId={applicationId}
  • Method: 
    GET

  • URL params

    ParameterValueDescription
    fqnstringThe fully qualified name of the CTL schema
    versionintegerThe version number of the CTL schema
    tenantIdstringThe ID of the tenant
    applicationIdstringThe ID of the application
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe Tenant ID of the CTL schema does not match the Tenant ID of the authenticated user
    404 Not FoundA CTL schema with the specified fully qualified name and version number does not exist.
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get CTL schema with application token

Returns a CTL schema with application token. Only authorized users are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/CTL/appToken/getSchema?fqn={fqn}&version={version}&tenantId={tenantId}&applicationToken={applicationToken}
  • Method: 
    GET

  • URL params

    ParameterValueDescription
    fqnstringThe fully qualified name of the CTL schema
    versionintegerThe version number of the CTL schema
    tenantIdstringThe ID of the tenant
    applicationTokenstringThe token of the application
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe Tenant ID of the CTL schema does not match the Tenant ID of the authenticated user
    404 Not FoundA CTL schema with the specified fully qualified name and version number does not exist.
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Check CTL schema FQN

Checks if CTL schema with same fqn is already exists in the sibling application. Only authorized users are allowed to perform this operation.

As of release 0.9.0 this method is deprecated, replaced by Check CTL schema FQN with application token.

  • URL 
    /kaaAdmin/rest/api/CTL/checkFqn?fqn={fqn}&tenantId={tenantId}&applicationId={applicationId}
  • Method: 
    GET

  • URL params

    ParameterValueDescription
    fqnstringThe fully qualified name of the CTL schema
    tenantIdstringThe ID of the tenant
    applicationIdstringThe ID of the application
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe Tenant ID of the CTL schema does not match the Tenant ID of the authenticated user
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Check CTL schema FQN with application token

Checks if CTL schema with same fqn is already exists in the sibling application with application token. Only authorized users are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/CTL/appToken/checkFqn?fqn={fqn}&tenantId={tenantId}&applicationToken={applicationToken}
  • Method: 
    GET

  • URL params

    ParameterValueDescription
    fqnstringThe fully qualified name of the CTL schema
    tenantIdstringThe ID of the tenant
    applicationTokenstringThe token of the application
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe Tenant ID of the CTL schema does not match the Tenant ID of the authenticated user
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Promote CTL schema from application scope to Tenant

Promote existing CTL schema meta info scope from application to tenant. Only authorized users are allowed to perform this operation.

 

  • URL 
    /kaaAdmin/rest/api/CTL/promoteScopeToTenant?fqn={fqn}&applicationId={applicationId}
  • Method: 
    POST

  • URL params

    ParameterValueDescription
    fqnstringThe fully qualified name of the CTL schema
    applicationIdstringThe ID of the application
  • Data params

    None

     

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe Tenant ID of the CTL schema does not match the Tenant ID of the authenticated user
    500 Internal Server ErrorAn unexpected error occurred on the server side

     

  • Sample call:

     Example result

Get system CTL schemas

Returns a list of available system CTL schemas metadata. Only authorized users are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/CTL/getSystemSchemas
  • Method: 
    GET

  • URL params

    None

  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get tenant CTL schemas

Returns a list of available CTL schemas metadata for current tenant. Only authorized users are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/CTL/getTenantSchemas
  • Method: 
    GET

  • URL params

    None

  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get application CTL schemas

Returns a list of available CTL schemas metadata for an application. Only authorized users are allowed to perform this operation.

As of release 0.9.0 this method is deprecated, replaced by Get application CTL schemas by application Token.

  • URL 
    /kaaAdmin/rest/api/CTL/getApplicationSchemas/{applicationId}
  • Method: 
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringThe ID of the application
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER, or TENANT_USER) or Tenant ID of the application does not match the Tenant ID of the user
    404 Not FoundAn application with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get application CTL schemas by application Token

Returns a list of available CTL schemas metadata for an application based on application token. Only authorized users are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/CTL/appToken/getApplicationSchemas/{applicationToken}
  • Method: 
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringThe token of the application
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER, or TENANT_USER) or Tenant ID of the application does not match the Tenant ID of the user
    404 Not FoundAn application with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Export CTL schema

Exports a CTL schema and, depending on the export method specified, all of its dependencies. Only authorized users are allowed to perform this operation.

As of release 0.9.0 this method is deprecated, replaced by Export CTL schema with application token.

  • URL 
    /kaaAdmin/rest/api/CTL/exportSchema?fqn={fqn}&version={version}&method={method}&applicationId={applicationId}
  • Method:
    POST

  • URL params

    ParameterValueDescription
    fqnstringThe fully qualified name of the CTL schema
    versionintegerThe version number of the CTL schema
    methodstringThe schema export method (either SHALLOW, FLAT, DEEP or LIBRARY)
    applicationIdstringThe ID of the application
  • Data params

    None

  • Success response:

    • Code: 200 
    • CTL schema file data: application/json - for SHALLOW or FLAT; application/zip - for DEEP; application/java-archive - for LIBRARY.

       

  • Error response:

    Status codesDescription
    400 Bad RequestUnknown export method specified
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundThe CTL schema with the given fqn, version and application Id does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

Export CTL schema with application token

Exports a CTL schema with application token and, depending on the export method specified, all of its dependencies. Only authorized users are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/CTL/appToken/exportSchema?fqn={fqn}&version={version}&method={method}&applicationToken={applicationToken}
  • Method:
    POST

  • URL params

    ParameterValueDescription
    fqnstringThe fully qualified name of the CTL schema
    versionintegerThe version number of the CTL schema
    methodstringThe schema export method (either SHALLOW, FLAT, DEEP or LIBRARY)
    applicationTokenstringThe token of the application
  • Data params

    None

  • Success response:

    • Code: 200 
    • CTL schema file data: application/json - for SHALLOW or FLAT; application/zip - for DEEP; application/java-archive - for LIBRARY.

       

  • Error response:

    Status codesDescription
    400 Bad RequestUnknown export method specified
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundThe CTL schema with the given fqn, version and application Id does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

SDK profiles

Create SDK profile

Creates an SDK profile for further endpoint SDK generation. (Requires TENANT_DEVELOPER or TENANT_USER to perform this operation).

 

  • URL 
    /kaaAdmin/rest/api/createSdkProfile
  • Method: 
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

  • Error response:

     

  • Sample call:

     Example result

Delete SDK profile

Deletes an SDK profile from the database. (Requires TENANT_DEVELOPER or TENANT_USER to perform this operation).

 

  • URL 
    /kaaAdmin/rest/api/deleteSdkProfile?sdkProfileId={sdkProfileId}
  • Method: 
    POST

  • URL params

    ParameterValueDescription
    sdkProfileIdstringAn SDK profile ID
  • Data params

    None

  • Success response:

     

    • Code: 200

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundThe SDK profile with the specified ID does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side

     

  • Sample call:

Get SDK profiles for application

Returns a list of SDK profiles for the given application. (Requires TENANT_DEVELOPER or TENANT_USER to request this information).

As of release 0.9.0 this method is deprecated, replaced by Get SDK profiles for application based on application token.

 

  • URL 
    /kaaAdmin/rest/api/sdkProfiles/{applicationId}
  • Method: 
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringAn application ID
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundThe application with the specified ID does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side

     

  • Sample call:

     Example result

Get SDK profiles for application based on application token

Returns a list of SDK profiles for the given application based on application token. (Requires TENANT_DEVELOPER or TENANT_USER to request this information).

 

  • URL 
    /kaaAdmin/rest/api/sdkProfilesByAppToken/{applicationToken}
  • Method: 
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringAn application Token
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundThe application with the specified ID does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side

     

  • Sample call:

     Example result

Get specific SDK profile

Returns the SDK profile by its identifier. (Requires TENANT_DEVELOPER or TENANT_USER to request this information).


  • URL 
    /kaaAdmin/rest/api/sdkProfile/{sdkProfileId}
  • Method: 
    GET

  • URL params

    ParameterValueDescription
    sdkProfileIdstringAn SDK profile ID
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

       

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundThe SDK profile with the specified ID does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Generate endpoint SDK

Generates the endpoint SDK based on the SDK profile. (Requires TENANT_DEVELOPER or TENANT_USER to perform this operation).

  • URL 
    /kaaAdmin/rest/api/sdk?sdkProfileId={sdkProfileId}&targetPlatform={targetPlatform}
  • Method:
    POST

  • URL params

    ParameterValueDescription
    sdkProfileIdstringThe SDK profile's ID
    targetPlatformstringThe target platform's name (either JAVA, ANDROID, CPP, C or OBJC)
  • Data params

    None

  • Success response:

    • Code: 200 
    • SDK file raw data

       

  • Error response:

    Status codesDescription
    400 Bad RequestAn unknown target platform was specified
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundThe SDK profile with the given ID does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call (for android or java client file extension must be .jar):

    for another platforms extension must be .tar.gz:

     

     

     

Profiling

Get client-side endpoint profile schemas

Returns the client-side endpoint profile schemas for an application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information. A users can only request schemas for applications associated with the same user.

As of release 0.9.0 this method is deprecated, replaced by Get client-side endpoint profile schemas by application token.

  • URL 
    /kaaAdmin/rest/api/profileSchemas/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get client-side endpoint profile schemas by application token

Returns the client-side endpoint profile schemas for an application based on application token. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information. A users can only request schemas for applications associated with the same user.

  • URL 
    /kaaAdmin/rest/api/profileSchemasByAppToken/{applicationToken}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringthe token of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get client-side endpoint profile schema

Returns the client-side endpoint profile schema by Profile Schema ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/profileSchema/{profileSchemaId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    profileSchemaIdstringthe ID of the client-side endpoint profile schema
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the profile schema does not match the Tenant ID of the authenticated user
    404 Not FoundClient-side endpoint profile schema with the specified profileSchemaId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create client-side endpoint profile schema

Uploads a client-side endpoint profile schema. A unique version number will be generated (incrementally) for the uploaded schema, and the createdUsername field of the schema will be set to the name of the user who uploaded it. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/saveProfileSchema
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

 

  • Error response:

    Status codesDescription
    400 Bad RequestSpecified request body is not valid
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the profile schema does not match the Tenant ID of the authenticated user
    404 Not FoundApplication or referenced CT schema is not found
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get server-side endpoint profile schemas

Returns the server-side endpoint profile schemas for an application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information. A users can only request schemas for applications associated with the same user.

As of release 0.9.0 this method is deprecated, replaced by Get server-side endpoint profile schemas by application token.

  • URL 
    /kaaAdmin/rest/api/serverProfileSchemas/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get server-side endpoint profile schemas by application token

Returns the server-side endpoint profile schemas for an application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information. A users can only request schemas for applications associated with the same user.

  • URL 
    /kaaAdmin/rest/api/serverProfileSchemasByAppToken/{applicationToken}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringthe token of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get server-side endpoint profile schema

Returns the server-side endpoint profile schema by Server Profile Schema ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/serverProfileSchema/{serverProfileSchemaId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    serverProfileSchemaIdstringthe ID of the server-side endpoint profile schema
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the profile schema does not match the Tenant ID of the authenticated user
    404 Not FoundServer-side endpoint profile schema with the specified serverProfileSchemaId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create server-side endpoint profile schema

Uploads a server-side endpoint profile schema. A unique version number will be generated (incrementally) for the uploaded schema, and the createdUsername field of the schema will be set to the name of the user who uploaded it. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/saveServerProfileSchema
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

 

  • Error response:

    Status codesDescription
    400 Bad RequestSpecified request body is not valid
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the profile schema does not match the Tenant ID of the authenticated user
    404 Not FoundApplication or referenced CT schema is not found
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Update server-side endpoint profile

Update a server-side endpoint profile. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/updateServerProfile?endpointProfileKey&version&serverProfileBody
  • Method: 
    POST

  • URL params

    ParameterValueDescription
    endpointProfileKeystringthe key hash of the endpoint in Base64 URL safe format.
    versionintthe version of the server-side endpoint profile schema
    serverProfileBodystringthe server-side endpoint profile body
  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

 

  • Error response:

    Status codesDescription
    400 Bad RequestSpecified server-side profile body is not valid
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER)
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get profile based on endpoint key

Returns the endpoint profile based on endpoint key hash. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/endpointProfile/{endpointProfileKey}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointProfileKeystringthe key hash of the endpoint in Base64 URL safe format.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

 

Get client-side endpoint profile body based on endpoint key

Returns the client-side endpoint profile body based on endpoint key hash. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/endpointProfileBody/{endpointProfileKey}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointProfileKeystringthe key hash of the endpoint in Base64 URL safe format.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get client-side endpoint profiles by owner ID

NOTE: This method will be available in Kaa v0.8.1

Returns a list of client-side endpoint profiles by the ID of the endpoint owner. (Requires TENANT_DEVELOPER or TENANT_USER to request this information).

  • URL 
    /kaaAdmin/rest/api/endpointProfiles?userExternalId={userId}
  • Method: 
    GET

  • URL params

    ParameterValueDescription
    userExternalIdstringThe ID of the endpoint owner
  • Data params

    None

  • Success response:
     

    • Code: 200 

    •  Response body

      Example:

       

  • Error response:

    Status codesDescription
    400 Bad RequestInvalid endpoint user ID provided
    401 UnauthorizedThe user is not authenticated or invalid credentials provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundNo endpoint user with the given ID found
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Grouping

Get endpoint groups

Returns all endpoint groups for the specified application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

As of release 0.9.0 this method is deprecated, replaced by Get endpoint groups by application token.

  • URL 
    /kaaAdmin/rest/api/endpointGroups/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get endpoint groups by application token

Returns all endpoint groups for the specified application based on application token. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/endpointGroupsByAppToken/{applicationToken}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringthe token of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get endpoint group

Returns an endpoint group by Endpoint Group ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/endpointGroup/{endpointGroupId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointGroupIdstringthe id of the endpoint group
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundAn endpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit endpoint group

Creates or edits an endpoint group. If an endpoint group with the specified ID does not exist, it will be created. If an endpoint group with the specified ID exists, it will be updated. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/endpointGroup
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundAn endpoint group to be edited with the specified endpointGroupId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call to create sndpoint group:

     Example result

     

     

  • Sample call to edit endpoint group:

     Example result

Delete endpoint group

Deletes an endpoint group specified by Endpoint Group ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/delEndpointGroup?endpointGroupId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    endpointGroupIdstringThe ID of the endpoint group to be deleted
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestThe endpointGroupId parameter is empty
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundAn endpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

Get profile filter records

Returns all profile filter records for the specified endpoint group. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/profileFilterRecords?endpointGroupId&includeDeprecated
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointGroupIdstringThe ID of the endpoint group
    includeDeprecatedstring[“true” or ”false”] if “true”, all profile filter records will be returned, including deprecated ones. If “false”, only active and inactive profile filter records will be returned
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestThe endpointGroupId parameter is empty
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundAn endpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get profile filter record

Returns the profile filter record for the specified endpoint group and profile schema. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/profileFilterRecord?schemaId&endpointGroupId
  • Method:
    GET

  • URL params

    ParameterValueDescription
    schemaIdstringthe ID of the profile schema
    endpointGroupId
    stringthe ID of the endpoint group
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundAn endpoint group with the specified endpointGroupId does not exist or endpoint group does not have the specified profile filter record
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get vacant profile schemas

Returns all vacant (not being used by endpoint group profile filters) profile schemas for the specified endpoint group. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/vacantProfileSchemas?endpointGroupId
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointGroupIdstringthe id of the endpoint group
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundAn endpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create/edit profile filter


Creates or updates a profile filter. If a profile filter with the specified ID does not exist, then it will be created and its createUsername field will be set to the name of the user who has created it. f a profile filter with the specified ID exists, the profile filter will be updated and its modifyUsername will be set to the user who has submited the request. Only users with the  TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/profileFilter
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundAn endpoint group with the specified endpointGroupId does not exist or existing profile filter with the specified profileFilterId not found
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Activate profile filter

Activates a profile filter. Sets the status field of the profile filter to ACTIVE, increments the sequenceNumber field value by 1, and sets the activateUsername and activatedTime fields to the name of the user who submitted the request and the activation time, respectively Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/activateProfileFilter
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundProfile filter with the specified profileFilterId not found
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Deactivate profile filter

Deactivates a profile filter. Sets the status field of the profile filter to DEPRECATED, sets the deactivatedTime field value to the time of the deactivation request, and sets the deactivateUsername field to the name of the user who has submitted the request. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/deactivateProfileFilter
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundProfile filter with the specified profileFilterId not found
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Delete profile filter record

Deletes a profile filter record by profile schema ID and endpoint group ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/delProfileFilterRecord?schemaId&endpointGroupId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    schemaIdstringthe ID of the profile schema
    endpointGroupId
    stringthe ID of the endpoint group
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundAn endpoint group with the specified endpointGroupId does not exist or the endpoint group does not have the specified profile filter record
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call

 

Get profiles based on endpoint group id

Returns the endpoint profiles based on endpoint group id. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.
Default limit value equals "20", default offset value equals "0". Maximum limit value is "500".

  • URL 
    /kaaAdmin/rest/api/endpointProfileByGroupId?endpointGroupId&limit&offset
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointGroupIdstringthe id of the endpoint group.
    limitstringmaximum number of shown profiles. (optional parameter)
    offsetstringoffset from beginning of profiles list. (optional parameter)
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
    • Error response:

      Status codesDescription
      401 UnauthorizedThe user is not authenticated or invalid credentials were provided
      403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
      404 Not FoundApplication with the specified applicationId does not exist
      500 Internal Server ErrorAn unexpected error occurred on the server side
    • Sample call:

       Example result

Get client-side profiles bodies based on endpoint group id

Returns the client-side endpoint profiles bodies based on endpoint group id. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.
Default limit value equals "20", default offset value equals "0". Maximum limit value is "500".

  • URL 
    /kaaAdmin/rest/api/endpointProfileBodyByGroupId?endpointGroupId&limit&offset
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointGroupIdstringthe id of the endpoint group.
    limitstringmaximum number of shown profiles. (optional parameter)
    offsetstringoffset from beginning of profiles list. (optional parameter)
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Configuration

Get configuration schemas

Returns all configuration schemas for the specified application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation. The application must be associated with the user who has submitted the request.

As of release 0.9.0 this method is deprecated, replaced by Get configuration schemas by application token.

  • URL 
    /kaaAdmin/rest/api/configurationSchemas/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get configuration schemas by application token

Returns all configuration schemas for the specified application based on application token. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation. The application must be associated with the user who has submitted the request.

  • URL 
    /kaaAdmin/rest/api/configurationSchemasByAppToken/{applicationToken}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringthe token of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get configuration schema

Returns a configuration schema by configuration schema ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/configurationSchema/{configurationSchemaId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    configurationSchemaIdstringthe ID of the configuration schema
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the configuration schema does not match the Tenant ID of the authenticated user
    404 Not FoundConfiguration schema with the specified configurationSchemaId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create configuration schema

Uploads a configuration schema. A unique version number will be generated (incrementally) for the uploaded schema, and the createUsername field of the schema will be set to the name of the user who uploaded it. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/configurationSchema
  • Method:
    POST

  • URL params

    None

  • Data params

    Multipart/form-data encoding. Fields:

     configurationSchema (content-type: application/json)

    Example:

     file (content-type: application/octet-stream)

    File contents example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

 

  • Error response:

    Status codesDescription
    400 Bad RequestSpecified configuration schema is not a valid avro schema
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the configuration schema does not match the Tenant ID of the authenticated user
    404 Not FoundFile with a schema not found in the form data
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get configuration records

Returns all configuration records for the specified endpoint group. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/configurationRecords?endpointGroupId&includeDeprecated
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointGroupIdstringthe ID of the endpoint group
    includeDeprecatedstring[“true” or ”false”] if “true”, all configuration records will be returned, including deprecated ones. If “false”, only active and inactive configuration records will be returned
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundAn endpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get configuration record

Returns the configuration record for the specified endpoint group and configuration schema. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/configurationRecord?schemaId&endpointGroupId
  • Method:
    GET

  • URL params

    ParameterValueDescription
    schemaIdstringthe ID of the configuration schema
    endpointGroupId
    stringthe ID of the endpoint group
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundAn endpoint group with the specified endpointGroupId does not exist or the endpoint group does not have the requested configuration record
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get configuration record body

Returns the configuration record string body for the specified endpoint group and configuration schema. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/configurationRecordBody?schemaId&endpointGroupId
  • Method:
    GET

  • URL params

    ParameterValueDescription
    schemaIdstringthe ID of the configuration schema
    endpointGroupId
    stringthe ID of the endpoint group
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundAn endpoint group with the specified endpointGroupId does not exist or the endpoint group does not have the requested configuration record
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get vacant configuration schemas

Returns all vacant (not being used by endpoint group configurations) configuration schemas for the specified endpoint group. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/vacantConfigurationSchemas?endpointGroupId
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointGroupIdstringthe ID of the endpoint group
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundAn endpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit configuration


Creates or updates a configuration. If a configuration with the specified ID does not exist, then it will be created and its createUsername field will be set to the name of the user who has uploaded it. If a configuration with the specified ID exists, the configuration will be updated and its modifyUsername will be set to the user who has submitted the request. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/configuration
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundAn endpoint group with the specified endpointGroupId does not exist or a configuration with the specified configurationId not found
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit user configuration


Creates or updates a configuration for the specific user under the application. If a configuration with the specified user ID does not exist, then it will be created. If a configuration with the specified user ID exists, the configuration will be updated. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/userConfiguration
  • Method: 
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundA user with the specified userId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Activate configuration

Activates a configuration. Sets the status field of the configuration to ACTIVE, increments the sequenceNumber field value by 1, and sets the activateUsername and activatedTime fields to the name of the user who has submitted the request and the activation time, respectively.Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/activateConfiguration
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error rsponse:

    Statues codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not required the role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundConfiguration with the specified configurationId not found
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Deactivate configuration

Deactivates a configuration. Sets the status field of the configuration to DEPRECATED, sets the deactivatedTime field value to the time of the deactivation request, and sets the deactivateUsername field to the name of the user who has submitted the request. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/deactivateConfiguration
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundConfiguration with the specified configurationId not found
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Delete configuration record

Deletes a configuration record by configuration schema ID and endpoint group ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/delConfigurationRecord?schemaId&endpointGroupId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    schemaIdstringthe ID of the configuration schema
    endpointGroupId
    stringthe ID of the endpoint group
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestendpointGroupId parameter is empty
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundAn endpoint group with the specified endpointGroupId does not exist or the endpoint group does not have the requested configuration record
    500 Internal Server ErrorAn unexpected error occurred on the server side

 

  • Sample call:

 

 

Notifications

 

Get notification schemas

Returns notification schemas for an application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information. The Tenant ID value of the application must match the Tenant ID of the request submitter.

As of release 0.9.0 this method is deprecated, replaced by Get notification schemas by application token.

  • URL 
    /kaaAdmin/rest/api/notificationSchemas/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringthe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the equired role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get notification schemas by application token

Returns notification schemas for an application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information. The Tenant ID value of the application must match the Tenant ID of the request submitter.

  • URL 
    /kaaAdmin/rest/api/notificationSchemasByAppToken/{applicationToken}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringthe token of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the equired role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get user notification schemas

Returns user notification schemas for an application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.
As of release 0.9.0 this method is deprecated, replaced by Get user notification schemas by application token.

  • URL 
    /kaaAdmin/rest/api/userNotificationSchemas/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringThe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get user notification schemas by application token

Returns user notification schemas for an application based on application token. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/userNotificationSchemasByAppToken/{applicationToken}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringThe token of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundApplication with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get notification schema

Returns a notification schema by notification schema ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/notificationSchema/{notificationSchemaId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    notificationSchemaIdstringThe ID of the notification schema
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the notification schema does not match the Tenant ID of the authenticated user
    404 Not FoundA notification schema with the specified notificationSchemaId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit notification schema

Creates or updates a notification schema. If a notification schema with the specified ID does not exist, then it will be created and its createUsername field of the schema will be set to the name of the user who has uploaded it, a unique version number will be generated (incrementally) for this schema. If a configuration with the specified ID exists, the configuration will be updated. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/notificationSchema
  • Method:
    POST

  • URL params

    None

  • Data params

    Multipart/form-data encoding. Fields:

     notificationSchema (content-type: application/json)

    Example:

     file (content-type: application/octet-stream)

    File contents example:

  • Success response:

    • Code: 200

       Response body

      Example:

  • Error response:

    Status codesDescription
    400 Bad RequestThe specified notification schema is not a valid avro schema
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the notification schema does not match the Tenant ID of the authenticated user
    404 Not FoundA file with a schema was not found in the form data
    500 Internal Server ErrorAn unexpected error occurred on the server side

     

     

  • Sample call to create notification schema:

     Example result
  • Sample call to edit notification schema:

     Example result

Get topics

Returns all topics for the specified application. Only users with  the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

As of release 0.9.0 this method is deprecated, replaced by Get topics by application token.

  • URL 
    /kaaAdmin/rest/api/topics/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringThe ID of the application
  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundAn application with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get topics by application token

Returns all topics for the specified application based on application token. Only users with  the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/topicsByAppToken/{applicationToken}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringThe token of the application
  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundAn application with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get endpoint group topics

Returns all topics for the specified endpoint group. Only users with the  TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/topics?endpointGroupId
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointGroupIdstringThe ID of the endpoint group.
  • Data params

    None

  • Success response:

    • Code: 200 

       Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundAn endpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get vacant topics

Returns all vacant (not present in the endpoint group) topics for the specified endpoint group. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/vacantTopics/{endpointGroupId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    endpointGroupIdstringthe ID of the endpoint group.
  • Data params

    None

  • Success response:

    • Code: 200 

       Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundThe endpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get topic

Returns a topic by topic ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/topic/{topicId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    topicIdstringThe ID of the topic
  • Data params

    None

  • Success response:

    • Code: 200 

       Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestThe topicId parameter is empty
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the topic does not match the Tenant ID of the authenticated user
    404 Not FoundA topic with the specified topicId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit topic

Creates or edits a topic. If a topic with the specified ID does not exist, it will be created. If a topic with the specified ID exists, it will be updated. Only users with theTENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/topic
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the topic does not match the Tenant ID of the authenticated user
    404 Not FoundA topic to be edited with the specified topicId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Delete topic

Deletes a topic. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/delTopic?topicId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    topicIdstringthe ID of the topic to be deleted
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestThe topicId parameter is empty
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the topic does not match the Tenant ID of the authenticated user
    404 Not FoundA topic with the specified topicId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

Add topic to endpoint group

Adds the specified topic to the specified endpoint group. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/addTopicToEpGroup?endpointGroupId&topicId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    endpointGroupIdstringThe ID of the endpoint group
    topicIdstringThe ID of the topic
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestThe endpointGroupId or topicId parameter is empty
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the topic or the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundA topic with the specified topicId or an endpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

Remove topic from endpoint group

Removes the specified topic from the specified endpoint group. Only users with the  TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/removeTopicFromEpGroup?endpointGroupId&topicId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    endpointGroupIdstringThe ID of the endpoint group
    topicIdstringThe ID of the topic
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestThe endpointGroupId or topicId parameter is empty
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the topic or the endpoint group does not match the Tenant ID of the authenticated user
    404 Not FoundA topic with the specified topicId or an endpoint group with the specified endpointGroupId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

Send notification


Sends a notification with the notification body from the specified file. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/sendNotification
  • Method:
    POST

  • URL params

    None

  • Data params

    Multipart/form-data encoding. Fields:

     notification (content-type: application/json)

    Example:

    If you want to set ttl, you must to set expiredAt in parameter notification.

     notification (content-type: application/json)

    Example:

     file contents example for Union type of field message (content-type: application/octet-stream)

    File contents example for Union type of field message:

     file contents example for primitive string type of field message (content-type: application/octet-stream)

    File contents example for primitive string type of field message:

     

     

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestThe specified notification is not valid
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the specified application or the application associated with the specified topic does not match the Tenant ID of the authenticated user
    404 Not FoundA file with the notification body was not found in the form data or an application with the specified ID does not exist or a topic with the specified ID does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

     

     

Send unicast notification


Sends a unicast notification with the notification body from the specified file to the client identified by endpointKeyHash. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/sendUnicastNotification
  • Method:
    POST

  • URL params

    None

  • Data params

    Multipart/form-data encoding. Fields:

     notification (content-type: application/json)

    Example:

    If you want to set ttl, you must to set expiredAt in parameter notification.

     notification (content-type: application/json)

    Example:

     endpointKeyHash (content-type: text/plain)

    Example:

     file contents example for Union type of field message (content-type: application/octet-stream)

    File contents example for Union type of field message:

     file contents example for primitive string type of field message (content-type: application/octet-stream)

    File contents example for primitive string type of field message:

     

     

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestThe specified notification is not valid
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the specified application or the application associated with the specified topic does not match the Tenant ID of the authenticated user
    404 Not FoundA file with the notification body was not found in the form data or an application with the specified ID does not exist or a topic with the specified ID does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

     

     

     

Events

Get event class families

Returns all event class families for the current authorized user within the current tenant. Only users with the TENANT_ADMIN role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/eventClassFamilies
  • Method:
    GET

  • URL params

    None

  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the TENANT_ADMIN role
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get event class family

Returns an event class family by event class family IDOnly users with the TENANT_ADMIN role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/eventClassFamily/{eventClassFamilyId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    eventClassFamilyIdstringThe ID of the event class family
  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role TENANT_ADMIN or the Tenant ID of the event class family does not match the Tenant ID of the user
    404 Not FoundAn event class family with the specified eventClassFamilyId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit event class family

Creates or edits an event class family. If an event class family with the specified ID does not exist, it will be created. If an event class family with the specified ID exists, it will be updated. Only users with the TENANT_ADMIN role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/eventClassFamily
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200

       Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_ADMIN) or the Tenant ID of the editing event class family does not match the Tenant ID of the user
    404 Not FoundAn event class family to be edited with the specified eventClassFamilyId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call to create event class family:

     Example result
  • Sample call to edit event class family:

     Example result

Add event class family schema

Adds the event class family schema to the event class family with the specified ID. The current user will be marked as the creator of schema. Only users with the TENANT_ADMIN role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/addEventClassFamilySchema
  • Method:
    POST

  • URL params

    None

  • Data params

    Multipart/form-data encoding. Fields:

     eventClassFamilyId (content-type: text/plain)

    Example:

     file (content-type: application/octet-stream)

    File contents example:

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestThe specified event class family schema is not a valid avro schema
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_ADMIN) or the Tenant ID of the specified event class family does not match the Tenant ID of the authenticated user
    404 Not FoundA file with the event class family schema was not found in the form data or an event class family with the specified ID does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

Get event classes

Gets event classes by event class family ID, version and type. Only users with the TENANT_ADMIN, TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/eventClasses?eventClassFamilyId&version&type
  • Method:
    GET

  • URL params

    ParameterValueDescription
    eventClassFamilyIdstringThe ID of the event class family
    versionstringThe version of the event class family schema
    typestringThe event classes type, one of ["EVENT", "OBJECT"]
  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

     
  • Error response:

    Status codesDescription
    400 Bad RequestOne of the url parameters is empty (eventClassFamilyId, version or type)
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_ADMIN, TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the event class family does not match the Tenant ID of the authenticated user
    404 Not FoundAn event class family with the specified eventClassFamilyId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get application event family maps

Returns all application event family maps for the specified application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

As of release 0.9.0 this method is deprecated, replaced by Get application event family maps by application token.

  • URL 
    /kaaAdmin/rest/api/applicationEventMaps/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringThe ID of the application
  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundAn application with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get application event family maps by application token

Returns all application event family maps for the specified application based on application token. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/applicationEventMapsByAppToken/{applicationToken}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringThe token of the application
  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundAn application with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get application event family map

Returns an application event family map by application event family map ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/applicationEventMap/{applicationEventFamilyMapId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationEventFamilyMapIdstringThe ID of the application event family map
  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the application event family map does not match the Tenant ID of the authenticated user
    404 Not FoundAn application event family map with the specified applicationEventFamilyMapId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit application event family map

Creates or edits an application event family map. If an application event family map with the specified ID does not exist, it will be created. If an application event family map with the specified ID exists, it will be updated. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/applicationEventMap
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200

       Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the equired role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the application event family map does not match the Tenant ID of the authenticated user
    404 Not FoundAn application event family map to be edited with the specified applicationEventFamilyMapId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get vacant event class families

Returns all vacant (not being used by application event family maps) event class families for the specified application. Only users with the  TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

As of release 0.9.0 this method is deprecated, replaced by Get application event family maps by application token.

  • URL 
    /kaaAdmin/rest/api/vacantEventClassFamilies/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringThe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundAn application with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get vacant event class families by application token

Returns all vacant (not being used by application event family maps) event class families for the specified application based on application token. Only users with the  TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/vacantEventClassFamiliesByAppToken/{applicationToken}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringThe token of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundAn application with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get application event class families

Returns all event class families for the specified application (being used by application event family maps). Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

As of release 0.9.0 this method is deprecated, replaced by Get application event class families by application token.

  • URL 
    /kaaAdmin/rest/api/eventClassFamilies/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringThe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundAn application with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get application event class families by application token

Returns all event class families for the specified application (being used by application event family maps) based on application token. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/eventClassFamiliesByAppToken/{applicationToken}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringThe token of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundAn application with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Logging

Get log schemas

Returns all log schemas for the specified application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information. The Tenant ID value of the application must match Tenant ID of the request submitter.

As of release 0.9.0 this method is deprecated, replaced by Get log schemas by application token.

  • URL 
    /kaaAdmin/rest/api/logSchemas/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringThe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundAn application with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get log schemas by application token

Returns all log schemas for the specified application based on application token. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information. The Tenant ID value of the application must match Tenant ID of the request submitter.

  • URL 
    /kaaAdmin/rest/api/logSchemasByAppToken/{applicationToken}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringThe token of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundAn application with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get log schema

Returns a log schema by log schema ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/logSchema/{logSchemaId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    logSchemaIdstringThe ID of the log schema
  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the log schema does not match the Tenant ID of the authenticated user
    404 Not FoundA log schema with the specified logSchemaId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get log schema by application token and schema version

Returns a log schema for the specified schema version and application token. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/logSchema/{applicationToken}/{schemaVersion}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringThe token of the application for the requested log schema
    schemaVersionstringThe version of the requested log schema
  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the log schema does not match the Tenant ID of the authenticated user
    404 Not FoundAn application with the specified application token does not exist or application does not have log schema with the specified schema version
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit log schema

Creates or updates a log schema. If a log schema with the specified ID does not exist, then it will be created and its createUsername field of the schema will be set to the name of the user who has uploaded it, a unique version number will be generated (incrementally) for this schema. If a configuration with the specified ID exists, the configuration will be updated. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/createLogSchema
  • Method:
    POST

  • URL params

    None

  • Data params

    Multipart/form-data encoding. Fields:

     logSchema (content-type: application/json)

    Example:

     file (content-type: application/octet-stream)

    File contents example:

  • Success response:

    • Code: 200

       Response body

      Example:

 

  • Error response:

    Status codesDescription
    400 Bad RequestThe specified log schema is not a valid avro schema
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the log schema does not match the Tenant ID of the authenticated user
    404 Not FoundA file with a schema not found in the form data
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call to create log schema:

     Example result

     

     

  • Sample call to edit log schema:

     Example result

Get log appenders

Returns all log appenders for the specified application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

As of release 0.9.0 this method is deprecated, replaced by Get log appenders by application token.

  • URL 
    /kaaAdmin/rest/api/logAppenders/{applicationId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringThe ID of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundAn application with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get log appenders by application token

Returns all log appenders for the specified application based on application token. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/logAppendersByAppToken/{applicationToken}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringThe token of the application.
  • Data params

    None

  • Success response:

     

    • Code: 200 

       Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundAn application with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Get log appender

Returns a log appender by log appender ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/logAppender/{logAppenderId}
  • Method:
    GET

  • URL params

    ParameterValueDescription
    logAppenderIdstringThe ID of the log appender
  • Data params

    None

  • Success response:

     

    • Code: 200 

    •  Response body

      Example:

     
  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the log appender does not match the Tenant ID of the authenticated user
    404 Not FoundA log appender with the specified logAppenderId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call:

     Example result

Create/Edit log appender

Creates or edits a log appender. If a log appender with the specified ID does not exist, it will be created. If a log appender with the specified ID exists, it will be updated. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/logAppender
  • Method:
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response:

    • Code: 200

       Response body

      Example:

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the log appender does not match the Tenant ID of the authenticated user
    404 Not FoundA log appender to be edited with the specified id does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call to create log appender:

     Example result

     

     

  • Sample call to edit log appender:

     Example result

Delete log appender

Deletes a log appender by log appender ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/delLogAppender?logAppenderId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    logAppenderIdstringthe ID of the log appender to be deleted
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    400 Bad RequestThe logAppenderId parameter is empty
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the log appender does not match the Tenant ID of the authenticated user
    404 Not FoundA log appender with the specified logAppenderId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side

Sample call:

Verifiers

Get verifiers

Returns all verifiers for the specified application. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

As of release 0.9.0 this method is deprecated, replaced by Get verifiers by application token.

  • URL 
    /kaaAdmin/rest/api/userVerifiers/{applicationId} 
  • Method
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringThe ID of the application.
  • Data params

    None

  • Success response
    • Code: 200 

       Response body

      Example:

       

  • Error response

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundAn application with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call

     Example result

Get verifiers by application token

Returns all verifiers for the specified application based on application token. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL 
    /kaaAdmin/rest/api/userVerifiersByAppToken/{applicationToken} 
  • Method
    GET

  • URL params

    ParameterValueDescription
    applicationTokenstringThe token of the application.
  • Data params

    None

  • Success response
    • Code: 200 

       Response body

      Example:

       

  • Error response

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application does not match the Tenant ID of the authenticated user
    404 Not FoundAn application with the specified applicationId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call

     Example result

Get verifier

Returns a verifier by its ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to request this information.

  • URL
    /kaaAdmin/rest/api/userVerifier/{userVerifierId}
  • Method
    GET

  • URL params

    ParameterValueDescription
    applicationIdstringThe ID of the application.

     

  • Data params

    None

  • Success response

    • Code: 200 

       Response body

      Example:


  • Error response

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the log appender does not match the Tenant ID of the authenticated user
    404 Not FoundA user verifier with the specified userVerifierId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call

     Example result

Create/edit user verifier

Creates or edits a user verifier. If the user verifier with the specified ID does not exist, it will be created. If the user verifier with the specified ID exists, it will be updated. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/userVerifier
  • Method
    POST

  • URL params

    None

  • Data params

     Request body

    Example:

  • Success response

    • Code: 200

       Response body

      Example:

  • Error response

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the log appender does not match the Tenant ID of the authenticated user
    404 Not FoundA user verifier to be edited with the specified id does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call to create user verifier

     Example result
  • Sample call to edit user verifier

     Example result

Delete user verifier

Deletes a user verifier by the user verifier ID. Only users with the TENANT_DEVELOPER or TENANT_USER role are allowed to perform this operation.

  • URL 
    /kaaAdmin/rest/api/delUsererVerifier?userVerifierId
  • Method:
    POST

  • URL params

    ParameterValueDescription
    userVerifierIdstringThe ID of the user verifier to be deleted
  • Data params

    None

  • Success response
    • Code: 200
  • Error response

    Status codesDescription
    400 Bad RequestThe userVerifierId parameter is empty
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_DEVELOPER or TENANT_USER) or the Tenant ID of the application associated with the log appender does not match the Tenant ID of the authenticated user
    404 Not FoundA user verifier with the specified userVerifierId does not exist
    500 Internal Server ErrorAn unexpected error occurred on the server side
  • Sample call

     Example result
  • Sample call:

     Example result

 

Sample call:

 Example result

 

Device management

Provision security credentials 

 Using this credentials endpoint can interact with specified applicationOnly users with the TENANT_ADMIN role are allowed to submit this request.

  • URL 
    /kaaAdmin/rest/api/provisionCredentials?applicationToken={applicationToken}&credentialsBody={credentialsBody}
  • Method: 
    POST

  • URL params

    ParameterValueDescription
    applicationTokenstringThe token of application
    credentialsBodystringThe public key hash of the endpoint in Base64 URL safe format
  • Data params

    None

  • Success response:

    • Code: 200 
    •  Response body

      Example:

  • Error response:

    Status codesDescription
    400 Bad RequestParameter conditions "applicationToken, credentialsBody" not met for actual request parameters
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_ADMIN)
    404 Not FoundThe requested item was not found
    500 Internal Server ErrorAn unexpected error occurred on the server side

 

  • Sample call:

     Example result
    {
        "applicationToken":"404",
    	"credentialsBody":"encoding string of public key",
        "status":"AVAILABLE"
    }

Bind specified endpoint profile to the credentials

 Only users with the TENANT_ADMIN role are allowed to submit this request.

  • URL 
    /kaaAdmin/rest/api/provisionRegistration?applicationToken={applicationToken}&credentialsId={credentialsId}&serverProfileVersion={serverProfileVersion}&serverProfileBody={serverProfileBody}
  • Method: 
    POST

  • URL params

    ParameterValueDescription
    applicationTokenstringThe token of application
    credentialsIdstringThe ID of the credentials
    serverProfileVersionintegerThe version number of server profile
    serverProfileBodystringThe body of server profile

     

     

  • Data params

    None

  • Success response:
     

    • Code: 200 

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_ADMIN)
    500 Internal Server ErrorAn unexpected error occurred on the server side

 

  • Sample call:

Revoke security credentials from the corresponding credentials storage

Launches an asynchronous process to terminate all active sessions of the endpoint that uses these credentials. Only users with the TENANT_ADMIN role are allowed to submit this request.

  • URL 
    /kaaAdmin/rest/api/revokeCredentials?applicationToken={applicationToken}&credentialsId={credentialsId}
  • Method: 
    POST

  • URL params

    ParameterValueDescription
    applicationTokenstringThe token of application
    credentialsIdstringThe ID of the credentials
  • Data params

    None

  • Success response:

    • Code: 200

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_ADMIN)
    500 Internal Server ErrorAn unexpected error occurred on the server side

 

  • Sample call:

Notify the Kaa cluster about security credentials revocation

If an endpoint is already registered with the specified credentials, this API all launches an asynchronous process to terminate all active sessions of  the corresponding endpoint. Only users with the TENANT_ADMIN role are allowed to submit this request.

  • URL 
    /kaaAdmin/rest/api/notifyRevoked?applicationToken={applicationToken}&credentialsId={credentialsId}
  • Method: 
    POST

  • URL params

    ParameterValueDescription
    applicationTokenstringThe token of application
    credentialsIdstringThe ID of the credentials
  • Data params

    None

  • Success response:

    • Code: 200 

  • Error response:

    Status codesDescription
    401 UnauthorizedThe user is not authenticated or invalid credentials were provided
    403 ForbiddenThe authenticated user does not have the required role (TENANT_ADMIN
    500 Internal Server ErrorAn unexpected error occurred on the server side

 

  • Sample call:

curl -v -S -u devuser:devuser123 -X POST -H 'Content-Type: application/json' -d'{"userId":"externalUserId","appToken":"43390267759495641709","schemaVersion":"2","body":"{\"AddressList\":{\"array\":[{\"label\":{\"string\":\"Kaa website\"},\"url\":{\"string\":\"http://www.kaaproject.org\"},\"__uuid\":null}]},\"__uuid\":null}"}' "http://10.2.1.110:8080/kaaAdmin/rest/api/userConfiguration" | python -mjson.tool
userExternalId

Copyright © 2014-2015, CyberVision, Inc.

G
M
T

 

           

 

Звукова функція обмежена 100 символами
G
M
T

 

           

 

Звукова функція обмежена 100 символами
  • No labels

2 Comments

  1. The creation of TENANT_DEVELOPERS or TENANT_USERS via REST is not working... (sad)

  2. i don't know how exactly what i have to do to make request via REST API using curl PHP, i get an error" Required request part 'notification' is not present".

    my code:

    if(isset($_FILES['file'])){
        $ch = curl_init();
       $headers = array();
       $headers[] = 'Authorization: Basic ZGV2dXNlcjpkZXZ1c2VyMTIz';
       $headers[] = 'Content-Type: multipart/form-data';
       $headers[] = 'Content-Length: 1024';
       curl_setopt($ch, CURLOPT_URL, 'http://192.168.1.111:8080/kaaAdmin/rest/api/sendNotification');
       curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
       curl_setopt($ch, CURLOPT_TIMEOUT, '3');
       curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
       curl_setopt($ch, CURLOPT_POST, 1);
       curl_setopt($ch,CURLOPT_POSTFIELDS,
             array(json_encode(array('notification'=>'{"applicationId":"32768","schemaId":"32771","topicId":"32768","type":"USER"}')),
                 'file' =>'@'. $_FILES['file'].';filename='. $_FILES['file']['name']
             ));
      $content = curl_exec($ch);
       print $content;
       if(!$content){
          die('Error: "' . curl_error($curl) . '" - Code: ' . curl_errno($curl));
      };
      curl_close($ch);

    }