Skip to content

MindSphere Credentials

Introduction

The MindSphere Credentials contain details for fetching new tokens and store fetched tokens.

Hint

Placeholders in the following samples are indicated by angular brackets < >.

Creating MindsphereCredentials Objects

Object Name: MindsphereCredentials

Creating MindsphereCredentials using a User Token

1
2
3
MindsphereCredentials credentials = MindsphereCredentials.userTokenBuilder()
                                        .authorization(<user_token>)
                                        .build();
Deprecated Method

The following method for creating service credentials using a user token is deprecated and shall not be used anymore:

1
2
3
MindsphereCredentials credentials = MindsphereCredentials.builder()
                                        .authorization(<user_token>)
                                        .build();

Creating MindsphereCredentials using App Specific Service Credentials

The app specific service credentials must be provided programmatically or via environment variables. App specific service credentials are obtained from Developer Cockpit or Operator Cockpit.

1
2
3
4
5
6
7
8
MindsphereCredentials credentials = MindsphereCredentials.appCredentialsBuilder()
                                        .keyStoreClientId(<client_id>)
                                        .keyStoreClientSecret(<client_secret>)
                                        .appName(<app_name>)
                                        .appVersion(<app_version>)
                                        .hostTenant(<host_tenant>)
                                        .userTenant(<user_tenant>)
                                        .build();

Creating MindsphereCredentials using Tenant Specific Service Credentials

The tenant specific service credentials must be provided programmatically or via environment variables. Tenant specific service credentials are obtained as described in Accessing MindSphere APIs with Service Credentials. If credentials are set via environment variables, the MindsphereCredentials object does not need to be build.

1
2
3
4
5
MindsphereCredentials credentials = MindsphereCredentials.tenantCredentialsBuilder()
                                        .clientId(<client_id>)
                                        .clientSecret(<client_secret>)
                                        .tenant(<tenant>)
                                        .build();
Deprecated Method

The following method for creating tenant specific service credentials is deprecated and shall not be used anymore:

1
2
3
4
5
MindsphereCredentials credentials = MindsphereCredentials.builder()
                                        .clientId(<client_id>)
                                        .clientSecret(<client_secret>)
                                        .tenant(<tenant_name>)
                                        .build();

Creating MindsphereCredentials using Tenant specific Service Credentials for Subtenant Impersonation

The tenant specific service credentials for subtenant impersonation must be provided programmatically or via environment variables.

1
2
3
4
5
6
7
MindsphereCredentials credentials = MindsphereCredentials.tenantCredentialsBuilder()
                                        .clientId(<client_id>)
                                        .clientSecret(<client_secret>)
                                        .tenant(<tenant>)
                                        .subTenant(<subtenant>)
                                        .tokenType(TokenScope.SUB_TENANT)
                                        .build();

Any questions left?

Ask the community


Except where otherwise noted, content on this site is licensed under the MindSphere Development License Agreement.