Bosch IoT Rollouts

SOUP Authorization

The System Software Update extension is currently under development. The provided documentation aims to give insights into the general concepts of the future offering. However, details including APIs may be subject to change.

Table of contents:

Introduction

Authorization is controlled via roles or scopes provided within the OAuth2 Json Web Token. The management of these roles or scopes and how the user can request them is in the responsibility of the customer and their Identity Provider (e.g. Bosch IdM, or Bosch User Hub).

Roles

Role name

Description

Interface

SYSTEM_ADMIN

Role for managing the tenant configuration (e.g. validation rules, template). Therefore, access to tenant configuration.

Management API/UI

TAG_ADMIN

Role for managing tags (e.g. to group recipes for dedicated products). Therefore, access to tags including their visibility to systems.

Management API/UI

APPROVE

Role for implementing 4-eyes principle before releasing a recipe. Therefore, full read access on recipes to inspect the recipe which shall be approved. In addition, possibility to approve or deny the requested release.

Management API/UI

TEST_INSTALLER

Full access to Install API. Access to recipes in state RELEASE_CANDIDATE, RELEASED, REVOKED, INACTIVE

Install API

BASIC

Role for general read access.

Management API/UI

UPDATE_COORDINATOR

Role for managing recipes. Therefore, full access on recipes and read access to systems.

Management API/UI

Scopes

Scope name

Description

Interface

management-access

Full access to Management API.

Management API

install-access

Full access to Install API. Access to recipes in state RELEASED, REVOKED, INACTIVE only.

Install API

API to role and scope mapping

Install API - Recipes

SYSTEM_ADMIN

TAG_ADMIN

APPROVE

TEST_INSTALLER

BASIC

UPDATE_COORDINATOR

install-access

management-access

[GET] /api/install/v1/recipes

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

[GET] /api/install/v1/recipes/{recipeId}

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

[GET] /api/install/v1/recipes/{recipeId}/signatures

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

[GET] /api/install/v1/recipes/{recipeId}/signatures/{signatureId}/file

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

[GET] /api/install/v1/recipes/{recipeId}/signature

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

[GET] /api/install/v1/recipes/{recipeId}/file

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-










Install API - System Feedback

SYSTEM_ADMIN

TAG_ADMIN

APPROVE

TEST_INSTALLER

BASIC

UPDATE_COORDINATOR

install-access

management-access

[POST] /api/install/v1/system-reports

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

[POST] /api/install/v1/update-reports

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-










Install API - Artifacts

SYSTEM_ADMIN

TAG_ADMIN

APPROVE

TEST_INSTALLER

BASIC

UPDATE_COORDINATOR

install-access

management-access

[GET] /api/install/v1/software-artifacts/{artifactId}/file

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-










Install API - Recipe Tags

SYSTEM_ADMIN

TAG_ADMIN

APPROVE

TEST_INSTALLER

BASIC

UPDATE_COORDINATOR

install-access

management-access

[GET] /api/install/v1/recipe-tags

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-










Management API - Systems

SYSTEM_ADMIN

TAG_ADMIN

APPROVE

TEST_INSTALLER

BASIC

UPDATE_COORDINATOR

install-access

management-access

[GET] /api/mgmt/v1/systems

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[DELETE] /api/mgmt/v1/systems

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[GET] /api/mgmt/v1/systems/{systemId}

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[DELETE] /api/mgmt/v1/systems/{systemId}

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png










Management API - Recipe Tags

SYSTEM_ADMIN

TAG_ADMIN

APPROVE

TEST_INSTALLER

BASIC

UPDATE_COORDINATOR

install-access

management-access

[GET] /api/mgmt/v1/recipe-tags

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/recipe-tags

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[GET] /api/mgmt/v1/recipe-tags/{id}

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v22.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[PUT] /api/mgmt/v1/recipe-tags/{recipeTagId}

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[DELETE] /api/mgmt/v1/recipe-tags/{recipeTagId}

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png










Management API - Tenant Configuration

SYSTEM_ADMIN

TAG_ADMIN

APPROVE

TEST_INSTALLER

BASIC

UPDATE_COORDINATOR

install-access

management-access

[GET] /api/mgmt/v1/tenant-config

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/tenant-config

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[GET] /api/mgmt/v1/tenant-config/{configKey}

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/tenant-config/{configKey}

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png










Management API - Jobs

SYSTEM_ADMIN

TAG_ADMIN

APPROVE

TEST_INSTALLER

BASIC

UPDATE_COORDINATOR

install-access

management-access

[GET] /api/mgmt/v1/jobs/recipe-match

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png










Management API - Recipes

SYSTEM_ADMIN

TAG_ADMIN

APPROVE

TEST_INSTALLER

BASIC

UPDATE_COORDINATOR

install-access

management-access

[GET] /api/mgmt/v1/recipes

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/recipes

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[GET] /api/mgmt/v1/recipes/{recipeId}

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v22.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[PUT] /api/mgmt/v1/recipes/{recipeId}

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[DELETE] /api/mgmt/v1/recipes/{recipeId}

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[GET] /api/mgmt/v1/recipes/{recipeId}/metadata

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/recipes/{recipeId}/metadata

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png










Management API - Recipes - Tags

SYSTEM_ADMIN

TAG_ADMIN

APPROVE

TEST_INSTALLER

BASIC

UPDATE_COORDINATOR

install-access

management-access

[GET] /api/mgmt/v1/recipes/{recipeId}/tags

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/recipes/{recipeId}/tags

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[DELETE] /api/mgmt/v1/recipes/{recipeId}/tags

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png










Management API - Recipes - System Distribution Sets

SYSTEM_ADMIN

TAG_ADMIN

APPROVE

TEST_INSTALLER

BASIC

UPDATE_COORDINATOR

install-access

management-access

[GET] /api/mgmt/v1/recipes/{recipeId}/system-distribution-sets

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/recipes/{recipeId}/system-distribution-sets

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[GET] /api/mgmt/v1/recipes/{recipeId}/system-distribution-sets/{sysDsId}

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[PUT] /api/mgmt/v1/recipes/{recipeId}/system-distribution-sets/{sysDsId}

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[DELETE] /api/mgmt/v1/recipes/{recipeId}/system-distribution-sets/{sysDsId}

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[GET] /api/mgmt/v1/recipes/{recipeId}/system-distribution-sets/{sysDsId}/metadata

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/recipes/{recipeId}/system-distribution-sets/{sysDsId}/metadata

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png










Management API - Recipes - Module Update Definitions

SYSTEM_ADMIN

TAG_ADMIN

APPROVE

TEST_INSTALLER

BASIC

UPDATE_COORDINATOR

install-access

management-access

[GET] /api/mgmt/v1/recipes/{recipeId}/module-update-definitions

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/recipes/{recipeId}/module-update-definitions

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[GET] /api/mgmt/v1/recipes/{recipeId}/module-update-definitions/{modDefId}

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[PUT] /api/mgmt/v1/recipes/{recipeId}/module-update-definitions/{modDefId}

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[DELETE] /api/mgmt/v1/recipes/{recipeId}/module-update-definitions/{modDefId}

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/recipes/{recipeId}/module-update-definitions/{modDefId}/up

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/recipes/{recipeId}/module-update-definitions/{modDefId}/down

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[GET] /api/mgmt/v1/recipes/{recipeId}/module-update-definitions/{modDefId}/metadata

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/recipes/{recipeId}/module-update-definitions/{modDefId}/metadata

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png










Management API - Recipe - Signatures

SYSTEM_ADMIN

TAG_ADMIN

APPROVE

TEST_INSTALLER

BASIC

UPDATE_COORDINATOR

install-access

management-access

[GET] /api/mgmt/v1/recipes/{recipeId}/signatures

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/recipes/{recipeId}/signatures

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[GET] /api/mgmt/v1/recipes/{recipeId}/signatures/{signatureId}

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[DELETE] /api/mgmt/v1/recipes/{recipeId}/signatures/{signatureId}

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[GET] /api/mgmt/v1/recipes/{recipeId}/signatures/{signatureId}/file

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png










Management API - Recipe - Lifecycle

SYSTEM_ADMIN

TAG_ADMIN

APPROVE

TEST_INSTALLER

BASIC

UPDATE_COORDINATOR

install-access

management-access

[POST] /api/mgmt/v1/recipes/{recipeId}/revoke

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/recipes/{recipeId}/release

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/recipes/{recipeId}/promote

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/recipes/{recipeId}/deny

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/recipes/{recipeId}/demote

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/recipes/{recipeId}/deactivate

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[POST] /api/mgmt/v1/recipes/{recipeId}/approve

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

-

-

-

-










Management API - Recipe - Validation

SYSTEM_ADMIN

TAG_ADMIN

APPROVE

TEST_INSTALLER

BASIC

UPDATE_COORDINATOR

install-access

management-access

[POST] /api/mgmt/v1/recipes/{recipeId}/validate

-

-

-

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

[GET] /api/mgmt/v1/recipes/{recipeId}/validation-report

-

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

-

images/confluence/download/thumbnails/3615442476/Screenshot-2023-11-16-at-13.07.53-version-1-modificationdate-1711614043000-api-v2.png

Example OAuth2 JSON web token

The roles are listed in the ext section of the JWT token under com.bosch.roles. Scopes can be found in the scp section.

{
"aud": [],
"client_id": "{client_id}",
"exp": 1706666674,
"ext": {
"com.bosch.roles": [
"IDM2BCD_SOUP_12345678_SYSTEM_ADMIN",
"IDM2BCD_SOUP_12345678_TAG_ADMIN",
"IDM2BCD_SOUP_12345678_APPROVER",
"IDM2BCD_SOUP_12345678_UPDATE_COORDINATOR",
"IDM2BCD_XXXXXXXXXXX"
],
"email": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"orig_guid": {
"sub": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
},
"orig_id": {
"idp_id": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"iss": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"sub": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"username": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}
},
"iat": 1706623474,
"iss": "https://access.bosch-iot-suite.com/v2/",
"jti": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"nbf": 1706623474,
"scp": [
"service-instance.{service-instance-id}.iot-rollouts",
"organization.{org-id}.Purchaser",
"openid",
"offline_access"
],
"sub": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}