applications - Keyrock command

This command allows you to manage applications for Keyrock.

• List applications
• Get an applications
• Create an applications
• Update an applications
• Delete an applications

Common Options

Options	Description
--host VALUE, -h VALUE	broker or server host VALUE (required)
--help	show help (default: true)

List applications

This command lists all applications.

ngsi applications [command options] list [options]

Options

Options	Description
--host VALUE, -h VALUE	broker or server host VALUE (required)
--verbose, -v	verbose (default: false)
--pretty, -P	pretty format (default: false)
--help	show help (default: true)

Examples

Request:

ngsi applications list --pretty

{
  "applications": [
    {
      "id": "58de156f-0fec-400b-bc7c-86265a885bee",
      "name": "Test_application 1",
      "description": "test app",
      "image": "default",
      "url": "http://localhost",
      "redirect_uri": "http://localhost/login",
      "redirect_sign_out_uri": null,
      "grant_type": "password,authorization_code,implicit",
      "response_type": "code,token",
      "token_types": "jwt,permanent,bearer",
      "jwt_secret": "f2be71188564ba0a",
      "client_type": null,
      "urls": {
        "permissions_url": "/v1/applications/58de156f-0fec-400b-bc7c-86265a885bee/permissions",
        "roles_url": "/v1/applications/58de156f-0fec-400b-bc7c-86265a885bee/roles",
        "users_url": "/v1/applications/58de156f-0fec-400b-bc7c-86265a885bee/users",
        "pep_proxies_url": "/v1/applications/58de156f-0fec-400b-bc7c-86265a885bee/pep_proxies",
        "iot_agents_url": "/v1/applications/58de156f-0fec-400b-bc7c-86265a885bee/iot_agents",
        "trusted_applications_url": "/v1/applications/58de156f-0fec-400b-bc7c-86265a885bee/trusted_applications"
      }
    }
  ]
}

Get an application.

This command gets an application.

ngsi application [command options] get [options]

Options

Options	Description
--host VALUE, -h VALUE	broker or server host VALUE (required)
--aid VALUE, -i VALUE	application id (required)
--pretty, -P	pretty format (default: false)
--help	show help (default: true)

Examples

Request:

ngsi applications get --aid 58de156f-0fec-400b-bc7c-86265a885bee --pretty

{
  "application": {
    "id": "58de156f-0fec-400b-bc7c-86265a885bee",
    "name": "Test_application 1",
    "description": "test app",
    "secret": "921cf732-b39c-4e7c-815c-a91277e52b70",
    "url": "http://localhost",
    "redirect_uri": "http://localhost/login",
    "redirect_sign_out_uri": null,
    "image": "default",
    "grant_type": "password,authorization_code,implicit",
    "response_type": "code,token",
    "token_types": "jwt,permanent,bearer",
    "jwt_secret": "f2be71188564ba0a",
    "client_type": null,
    "scope": null,
    "extra": null,
    "urls": {
      "permissions_url": "/v1/applications/58de156f-0fec-400b-bc7c-86265a885bee/permissions",
      "roles_url": "/v1/applications/58de156f-0fec-400b-bc7c-86265a885bee/roles",
      "users_url": "/v1/applications/58de156f-0fec-400b-bc7c-86265a885bee/users",
      "pep_proxies_url": "/v1/applications/58de156f-0fec-400b-bc7c-86265a885bee/pep_proxies",
      "iot_agents_url": "/v1/applications/58de156f-0fec-400b-bc7c-86265a885bee/iot_agents",
      "trusted_applications_url": "/v1/applications/58de156f-0fec-400b-bc7c-86265a885bee/trusted_applications"
    }
  }
}

Create an application

This command creates an application.

ngsi application [command options] create [options]

Options

Options	Description
--host VALUE, -h VALUE	broker or server host VALUE (required)
--data VALUE, -d VALUE	application data
--name VALUE, -n VALUE	application name
--description VALUE, -D VALUE	description
--url VALUE, -u VALUE	url
--redirectUri VALUE, -R VALUE	redirect uri
--redirectSignOutUri VALUE, -S VALUE	redirect redirect sign out uri
--grantType VALUE, -g VALUE	grant type
--tokenTypes VALUE, -t VALUE	token types
--scope VALUE, -s VALUE	scopes to limit an application's access to a user's account
--openid, -o	enable OpenID Connect Authentication (default: false)
--verbose, -v	verbose (default: false)
--pretty, -P	pretty format (default: false)
--help	show help (default: true)

Examples

Request:

ngsi applications create --name "Test_application 1" \
  --description "test app" \
  --redirectUri http://localhost/login \
  --url http://localhost \
  --grantType authorization_code,implicit,password \
  --tokenTypes jwt,permanent

58de156f-0fec-400b-bc7c-86265a885bee

Request

ngsi applications create --name "FIWARE Draco" \
  --url https://draco.example.com \
  --redirectUri https://draco.example.com:443/nifi-api/access/oidc/callback \
  --openid

6418de2a-c50e-485e-bdc1-e714c6522d93

Request

ngsi applications create --name "FIWARE Draco" \
  --url https://draco.example.com \
  --redirectUri https://draco.example.com:443/nifi-api/access/oidc/callback \
  --scope openid \
  --tokenTypes jwt

247d64f7-a479-4b55-8047-46da8004506c

Update an application

This command updates an application.

ngsi application [command options] update [options]

Options

Options	Description
--host VALUE, -h VALUE	broker or server host VALUE (required)
--aid VALUE, -i VALUE	application id (required)
--data VALUE, -d VALUE	application data
--name VALUE, -n VALUE	application name
--description VALUE, -D VALUE	description
--url VALUE, -u VALUE	url
--redirectUri VALUE, -R VALUE	redirect uri
--redirectSignOutUri VALUE, -S VALUE	redirect redirect sign out uri
--grantType VALUE, -g VALUE	grant type
--tokenTypes VALUE, -t VALUE	token types
--scope VALUE, -s VALUE	scopes to limit an application's access to a user's account
--openid, -o	enable OpenID Connect Authentication (default: false)
--verbose, -v	verbose (default: false)
--pretty, -P	pretty format (default: false)
--help	show help (default: true)

Examples

Request:

ngsi applications update --aid 58de156f-0fec-400b-bc7c-86265a885bee --url http://orion/ --pretty

{
  "values_updated": {
    "url": "http://orion/",
    "token_types": "jwt,permanent,bearer,bearer",
    "scope": ""
  }
}

Delete an application

This command deletes an application.

ngsi application [command options] delete [options]

Options

Options	Description
--host VALUE, -h VALUE	broker or server host VALUE (required)
--aid VALUE, -i VALUE	application id (required)
--help	show help (default: true)

Examples

Request:

ngsi applications delete --aid 58de156f-0fec-400b-bc7c-86265a885bee