saps4hana.itcm.user
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_saps4hana.itcm.user_1.2.0.png)
ballerinax/saps4hana.itcm.user Ballerina library
Overview
This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. The User service allows you to create, add, and delete information about users in SAPS4HANA Intelligent Trade Claims Management.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create and configure an OAuth2 client credentials by following this guide.
Clients![](/images/permalink.svg)
saps4hana.itcm.user: Client![](/images/permalink.svg)
This is a generated connector for SAPS4HANA Intelligent Trade Claims Management API v1.0.0 OpenAPI specification. The User service allows you to create, add, and delete information about users in SAPS4HANA Intelligent Trade Claims Management.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create and configure an OAuth2 client credentials by following this guide.
init (ClientConfig clientConfig, string serviceUrl)
- clientConfig ClientConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
createUser![](/images/permalink.svg)
function createUser(UserProfileDTO payload) returns UserResponseDTO|error
Create a new User
Parameters
- payload UserProfileDTO - userProfileDTO
Return Type
- UserResponseDTO|error - Success Created.
Records![](/images/permalink.svg)
saps4hana.itcm.user: AvatarIconDTO![](/images/permalink.svg)
Fields
- 'type string? -
- value string? -
saps4hana.itcm.user: ClientConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth OAuth2ClientCredentialsGrantConfig - Configurations related to client authentication
- httpVersion string(default "1.1") - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- followRedirects FollowRedirects?(default ()) - Configurations associated with Redirection
- poolConfig PoolConfiguration?(default ()) - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig?(default ()) - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig?(default ()) - Configurations associated with retrying
- cookieConfig CookieConfig?(default ()) - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket?(default ()) - SSL/TLS-related options
saps4hana.itcm.user: OAuth2ClientCredentialsGrantConfig![](/images/permalink.svg)
OAuth2 Client Credintials Grant Configs
Fields
- Fields Included from *OAuth2ClientCredentialsGrantConfig
- tokenUrl string
- clientId string
- clientSecret string
- scopes string[]
- defaultTokenExpTime decimal
- clockSkew decimal
- optionalParams map<string>
- credentialBearer CredentialBearer
- clientConfig ClientConfiguration
- tokenUrl string(default "https://colgate-dev1.authentication.us30.hana.ondemand.com/oauth/token") - Token URL
saps4hana.itcm.user: ResponseForbiddenMessage![](/images/permalink.svg)
Fields
- message string? -
- timestamp string? -
- uri string? -
saps4hana.itcm.user: ResponseUnauthorizedMessage![](/images/permalink.svg)
Fields
- message string? -
- timestamp string? -
- uri string? -
saps4hana.itcm.user: UserNameDTO![](/images/permalink.svg)
Fields
- firstName string? -
- lastName string? -
saps4hana.itcm.user: UserProfileDTO![](/images/permalink.svg)
Fields
- avatarIcon AvatarIconDTO? -
- creationTime string? -
- dateFormat string? -
- email string? -
- externalUserId string? -
- familyNameFirst boolean? -
- id int? -
- language string? -
- phone string? -
- pictureId int? -
- role string? -
- s4ExternalUserId string? -
- status string? -
- tenantId int? -
- timeFormat string? -
- timeZone string? -
- userName UserNameDTO? -
- userUpdateState int? -
saps4hana.itcm.user: UserResponseDTO![](/images/permalink.svg)
Fields
- id int? -
- message string? -
- timestamp string? -
Import
import ballerinax/saps4hana.itcm.user;
Metadata
Released date: over 2 years ago
Version: 1.2.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.0.0
GraalVM compatible: Yes
Pull count
Total: 3
Current verison: 1
Weekly downloads
Keywords
Business Management/ERP
Cost/Paid
Contributors
Dependencies