REST Key Management SAP Provider

The implementation class of the REST Key Management SAP Provider is:

com.czertainly.trident.sam.sap.RestKeyManagementSapProvider

The following properties can be configured for the REST Key Management SAP Provider:

Property	Description	Default Value	Mandatory
KM_SAP_PROVIDER_URL	URL where is the REST interface implemented for key management. The URL should implement REST interface of this provider, specifically fot activation of the assigned key.	NONE	YES
KM_SAP_PROVIDER_AUTH_TYPE	Authorization type for the REST API. Supported values are: NONE BASIC See information about the authentication properties below.	NONE	YES

Authorization types

BASIC

KM_SAP_PROVIDER_AUTH_TYPE = BASIC needs additional properties to be configured, in particular:

Property	Description	Default Value	Mandatory
KM_SAP_PROVIDER_USERNAME	Identification of the user.	NONE	Mandatory for KM_SAP_PROVIDER_AUTH_TYPE = BASIC
KM_SAP_PROVIDER_PASSWORD	Password for the username.	NONE	Mandatory for KM_SAP_PROVIDER_AUTH_TYPE = BASIC

OpenAPI Definition

openapi: 3.0.3
info:
  title: REST Key Management SAP Provider
  version: v1
paths:
  /activateKey:
    post:
      operationId: buildActivateKey
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BuildActivateKeyRequestDTO'
        required: true
      responses:
        "200":
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/BuildActivateKeyResponseDTO'
components:
  schemas:
    BuildResponseDTO:
      type: object
      properties:
        body:
          type: array
          items:
            type: string
            format: byte
        nonce:
          type: array
          items:
            type: string
            format: byte
    BuildActivateKeyRequestDTO:
      type: object
      properties:
        userId:
          type: string
        keyId:
          type: string
    BuildActivateKeyResponseDTO:
      type: object
      required:
        - changeKeyPasswordRequest
        - changeKeyOperationStateRequest
      properties:
        changePukRequest:
          $ref: '#/components/schemas/BuildResponseDTO'
        changeKeyPasswordRequest:
          $ref: '#/components/schemas/BuildResponseDTO'
        changeKeyOperationStateRequest:
          $ref: '#/components/schemas/BuildResponseDTO'