com.siemens.mindsphere.sdk.agentmanagement.apiclient

Class RegistrationOperationsClient

Object

MindsphereAPIClient

RegistrationOperationsClient

public class RegistrationOperationsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RegistrationOperationsClient.ClientBuilder

Nested classes/interfaces inherited from class MindsphereAPIClient

MindsphereAPIClient.Builder<T extends MindsphereAPIClient.Builder<T>>

Field Summary

Fields inherited from class MindsphereAPIClient

credentials, restClientConfig, restTemplate

Constructor Summary

Constructors

Constructor and Description
RegistrationOperationsClient(RegistrationOperationsClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
static RegistrationOperationsClient.ClientBuilder	builder()
ClientIdentifier	registerClientIdPut(String registrationAccessToken, String clientId, RotationKeys keys) Update client information.
ClientIdentifier	registerPost(String initialAccessToken, Object keys) Register client.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RegistrationOperationsClient

public RegistrationOperationsClient(RegistrationOperationsClient.ClientBuilder builder)

Method Detail

builder

public static RegistrationOperationsClient.ClientBuilder builder()

registerClientIdPut

public ClientIdentifier registerClientIdPut(String registrationAccessToken,
                                            String clientId,
                                            RotationKeys keys)
                                     throws MindsphereException

Update client information. Updates clients information.

200 - OK

400 - Bad Request

401 - Unauthorized

500 - unexpected error

0 - Other error with any status code and response body format.

Parameters:

registrationAccessToken - Registration Access Token value with Bearer authentication scheme. e.g :Bearer eyJh...

clientId - Client identifier to update information.

keys - The client's key in JWKS for security profile RSA. If security profile is SHARED_SECRET there is only client_id in the JSON.* @return ClientIdentifier

Throws:

MindsphereException - if an error occurs while attempting to invoke the API

registerPost

public ClientIdentifier registerPost(String initialAccessToken,
                                     Object keys)
                              throws MindsphereException

Register client. Registers client based on given security profile.

201 - Created

400 - Bad Request

401 - Unauthorized

429 - TooManyRequests

500 - unexpected error

0 - Other error with any status code and response body format.

Parameters:

initialAccessToken - Initial Access Token value with Bearer authentication scheme. e.g :Bearer eyJh...

keys - The client's key in JWKS for security profile RSA. If security profile is SHARED_SECRET the value is empty JSON.

Returns:

ClientIdentifier

Throws:

MindsphereException - if an error occurs while attempting to invoke the API