Skip to content

Latest commit

 

History

History
403 lines (226 loc) · 5.92 KB

File metadata and controls

403 lines (226 loc) · 5.92 KB

Communication System - Read and Write Integration

This service enables you to:

  • Read and write communication systems

  • Read and write assigned inbound users, outbound users, communication arrangements as well as channels for Event Exchange Infrastructure and OpenID Connect configurations

This service is published on the SAP Business Accelerator Hub. For more information about APIs, see the Related Information section.

This is an OData version 4 service. This version aims to improve processing time and resource consumption of clients and servers. This includes a lightweight JSON format that reduces the size of every response.

Service Group (incl. Namespace if It Exists)

Repository ID

Service Name (incl. Namespace if It Exists)

Version

aps_com_cs_a4c_odata

srvd_a2x

aps_com_cs_a4c_odata

0001

Service Header (optional)

The service header contains information about the service.

Entities

The entities contain the business data of the service.


Entity

Description

Constants

Necessity

CommunicationSystems

Contains communication system data

Contains the following attributes and values:

  • Type

    • customer_managed

    • provider_managed

  • CipherSuites

    • TLS_1_0_to_1_2

    • TLS_1_0_to_1_3

    • TLS_1_2_only

    • TLS_1_2_to_1_3

    Please note that these values can also be empty.

  • IsCipherSuiteDefault

    • TLS_1_0_to_1_2

    • TLS_1_0_to_1_3

    • TLS_1_2_only

    • TLS_1_2_to_1_3

    Please note that these values can also be empty.

  • OAuth2IdentityProviderUserLogonType

    • user_uuid

    • user_name

  • SAMLBearerAssertionProviderUserLogonType

    • user_uuid

    • user_name

Mandatory

InboundUsers

Contains references to the communication user ID

Contains the following attributes and values:

  • OAuth2GrantType

    • authorization_code

    • saml2-bearer

    • ropc

    • client_credentials

  • OAuth2RefreshTokenExpiryUnit

    • days

    • months

    • years

  • AuthenticationMethod

    • x509

    • basic

    • none

    • oauth2

    • oauth2_mtls

    • sso2

    • oauth1

Optional

Event Channels

Contains Event Exchange Infrastructure channel information

 

Optional

OpenIDConnectProviders

Contains OpenID Connect configurations

Contains the following attributes and values:

  • UserMapping

    • global_user_id

    • email

    • user_name

  • UserMappingClaim

    • sub_claim

    • email_claim_verified

    • email_claim_unverified

    • oid_claim

    • user_name_claim

    • custom_claim

  • AudienceEvaluationMode

    • own_client_id_only

    • own_and_selected_other_client_ids

      Note:

      Please note that an OpenIDConnetAudiences entity is required for creating or changing this value.

    • own_and_all_other_client_ids

  • IsImportWebKeysActive

    Note:

    If this value is false, you must specify at least one OpenIDConnectWebKey entity. If this value is true, the WebKeysURL value or the Provider value is used to import the data of theOpenIDConnectWebKeys entities.

Optional

OutboundUsers

Contains outbound user data

Contains the following attributes and values:

  • OAuth2ClientAuthenticationMethod

    • basic

    • mtls

    • jwt

  • AuthenticationMethod

    • x509

    • basic

    • none

    • oauth2

    • oauth2_mtls

    • sso2

    • oauth1

Optional

BusinessPartners

Contains references to the business partner IDs

 

Optional

Note:

For more information about Communication Management, see the Related Information section.

Related Information

Communication Arrangements - Entity

APIs on SAP Business Accelerator Hub

Communication Management

Creating Communication Arrangements for SAP Event Mesh

Supported Protocols and Authentication Methods