AppConfig - REST API

Corie Lynch

December 09, 2022 22:15

Set Application Configuration
View Application Configuration

Set Application Configuration

Using the POST /app/{platform}/{package}/config endpoint will allow the configuration for a specific application package to be set.

POST

https://lab-api.nowsecure.com/app/:platform/:package/config

curl -H "Authorization: Bearer $NS_TOKEN" -X POST \
    https://lab-api.nowsecure.com/app/ios/com.nowsecure.demo.rvia/config?group=838929c6-73c8-11e8-a19d-27d57188d0f9 -d '
{
 "dynamic": {
   "search_data": {
     "name": {
       "value": "Arthur Dent",
       "is_sensitive": true,
       "search_strings": [
         "/name",
         "name",
         "fullname",
         "full_name",
         "full name",
         "full-name"
       ]
     },
     "firstname": {
       "value": "Arthur",
       "is_sensitive": true,
       "search_strings": [
         "First name",
         "first name",
         "firstname",
         "first_name",
         "first-name"
       ]
     },
     "lastname": {
       "value": "Dent",
       "is_sensitive": true,
       "search_strings": [
         "Last name",
         "last name",
         "lastname",
         "last_name",
         "last-name",
         "surname"
       ]
     },
     "phonenumber": {
       "value": "17068675309",
       "is_sensitive": true,
       "search_strings": [
         "Telephone number",
         "number",
         "phone Number",
         "phone num",
         "phone",
         "phonenumber",
         "tel"
       ]
     },
     "email": {
       "value": "arthur.dent@nowsecure.com",
       "is_sensitive": true,
       "search_strings": [
         "display name",
         "displayname",
         "e mail",
         "e-mail",
         "e_mail",
         "email",
         "login",
         "screename",
         "user id",
         "user",
         "user-id",
         "user-name",
         "user_id",
         "user_name",
         "userid",
         "username"
       ]
     },
     "username": {
       "value": "Arthur Dent",
       "is_sensitive": true,
       "search_strings": [
         "username",
         "user_name",
         "userid",
         "login",
         "screename",
         "displayname",
         "display name",
         "usr",
         "uid",
         "nuid",
         "uname"
       ]
     },
     "password": {
       "value": "d0n7p4nic42",
       "is_sensitive": true,
       "search_strings": [
         "password",
         "pswd",
         "pass",
         "pwd",
         "pass_word"
       ]
     },
     "zipcode": {
       "value": "90210",
       "is_sensitive": true,
       "search_strings": [
         "zipcode",
         "zip",
         "zip_code",
         "zip-code",
         "zip code"
       ]
     },
     "gpsLongitude": {
       "value": "41.0",
       "search_strings": []
     },
     "gpsLatitude": {
       "value": "42.0",
       "search_strings": []
     },
     "adid": {
       "value": "DEADBEEF-1234-1234-1234-123456789ABC",
       "search_strings": []
     },
     "idfv": {
       "value": "CAFEBABE-1234-1234-1234-123456789ABC",
       "search_strings": []
     }
   },
   "actions": {
     "find": [],
     "avoid": [
       "facebook",
       "G+",
       "Google plus",
       "Google",
       "GOOGLE"
     ]
   }
 }
}
'

HTTP/1.1 400 Bad Request
{
  "name": "BadRequestError",
  "message": "Valid $param required"
}

HTTP/1.1 404 Not Found
{
  "name": "NotFoundError",
  "message": "$resource not found within user scope"
}

HTTP/1.1 500 Internal Server Error
{
  "name": "InternalServerError"
}

Header

Field	Type	Description
`Authorization`	String	Send header with value `Bearer: ${API_TOKEN}` to authenticate

Route

Field	Type	Description
`platform`	String	The platform associated with application. Allowed values: "`ios`", "`android`"
package	String	The package identifier of application

Query

Field	Type	Description
`group`	String	The uuid group ref of application (only optional if user belongs to exactly one group)

Error 4XX

Field	Description
`BadRequestError`	Request is not properly formed, e.g. a parameter necessary to fulfill request is missing.
`NotFoundError`	Requested resource was not found within authenticated user's scope.
`InternalServerError`	Unexpected system failure occurred while processing request.

View Application Configuration

Using the GET /app/{platform}/{package}/config endpoint will allow the user to view the configuration for a specific application package to be set.

GET

https://lab-api.nowsecure.com/app/:platform/:package/config

curl -H "Authorization: Bearer ${API_TOKEN}" -X GET \
    https://lab-api.nowsecure.com/app/android/com.sample.android.testdpc/config?group=838929c6-73c8-11e8-a19d-27d57188d0f9

Header

Field	Type	Description
`Authorization`	String	Send header with value `Bearer: ${API_TOKEN}` to authenticate

Route

Field	Type	Description
`platform`	String	The platform associated with application. Allowed values: `"ios"`, `"android"`
`package`	String	The package identifier for application

Query

Field	Type	Description
`group`	String	The uuid group ref of application (only optional if user belongs to exactly one group)