saps4hana.pp.idm
Module saps4hana.pp.idm
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_saps4hana.pp.idm_1.4.0.png)
ballerinax/saps4hana.pp.idm Ballerina library
Overview
This is a generated connector for SAP S/4HANA Procurement Planning System for Cross-domain Identity Management API v1.0.0 OpenAPI specification.
This service allows to read and write user data. It will be used by the Identity Provisioning Service. The SCIM Service is protected by the Identity Authentication Service, so the customer must configure the authentication in the Identity Provisioning Service.
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.pp.idm: Client![](/images/permalink.svg)
This is a generated connector for SAP S/4HANA Procurement Planning System for Cross-domain Identity Management API v1.0.0 OpenAPI specification. This service allows to read and write user data. It will be used by the Identity Provisioning Service. The SCIM Service is protected by the Identity Authentication Service, so the customer must configure the authentication in the Identity Provisioning Service.
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 (ConnectionConfig config, string serviceUrl)
- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string - URL of the target service
getAllUsers![](/images/permalink.svg)
function getAllUsers() returns ReadMultipleUsers[]|error
Retrieves all users.
Return Type
- ReadMultipleUsers[]|error - Retrieved entities.
addNewUser![](/images/permalink.svg)
Adds a new user.
Parameters
- payload User - User object
getUserById![](/images/permalink.svg)
function getUserById(string id) returns ReadSingleUser|error
Retrieves the user.
Parameters
- id string - ID of the user that will be created.
Return Type
- ReadSingleUser|error - Retrieved entities.
updateUserById![](/images/permalink.svg)
Updates the user.
deleteUserById![](/images/permalink.svg)
function deleteUserById(string id) returns Success204|error
Deletes a user from the system.
Parameters
- id string - ID of the user that will be deleted.
Return Type
- Success204|error - The task was successfully completed and the context was updated.
Records![](/images/permalink.svg)
saps4hana.pp.idm: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
saps4hana.pp.idm: ConnectionConfig![](/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 HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - 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
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
saps4hana.pp.idm: Emails![](/images/permalink.svg)
Fields
- value string -
- 'type string? -
- primary boolean? -
saps4hana.pp.idm: Error![](/images/permalink.svg)
Fields
- 'error ErrorError -
saps4hana.pp.idm: Error400![](/images/permalink.svg)
Fields
- 'error Error400Error -
saps4hana.pp.idm: Error400Error![](/images/permalink.svg)
Fields
- status int -
- message string -
saps4hana.pp.idm: Error401![](/images/permalink.svg)
Fields
- 'error Error401Error -
saps4hana.pp.idm: Error401Error![](/images/permalink.svg)
Fields
- status int -
- message string -
saps4hana.pp.idm: Error403![](/images/permalink.svg)
Fields
- 'error Error403Error -
saps4hana.pp.idm: Error403Error![](/images/permalink.svg)
Fields
- status int -
- message string -
saps4hana.pp.idm: Error404![](/images/permalink.svg)
Fields
- 'error Error404Error -
saps4hana.pp.idm: Error404Error![](/images/permalink.svg)
Fields
- status int -
- message string -
saps4hana.pp.idm: Error405![](/images/permalink.svg)
Fields
- 'error Error405Error -
saps4hana.pp.idm: Error405Error![](/images/permalink.svg)
Fields
- status int -
- message string -
saps4hana.pp.idm: Error406![](/images/permalink.svg)
Fields
- 'error Error406Error -
saps4hana.pp.idm: Error406Error![](/images/permalink.svg)
Fields
- status int -
- message string -
saps4hana.pp.idm: Error409![](/images/permalink.svg)
Fields
- 'error Error409Error -
saps4hana.pp.idm: Error409Error![](/images/permalink.svg)
Fields
- status int -
- message string -
saps4hana.pp.idm: ErrorError![](/images/permalink.svg)
Fields
- status int -
- message string -
saps4hana.pp.idm: OAuth2ClientCredentialsGrantConfig![](/images/permalink.svg)
OAuth2 Client Credentials Grant Configs
Fields
- Fields Included from *OAuth2ClientCredentialsGrantConfig
- tokenUrl string(default "") - Token URL
saps4hana.pp.idm: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
saps4hana.pp.idm: ReadMultipleUsers![](/images/permalink.svg)
Fields
- schemas string[]? -
- totalResults decimal? -
- itemsPerPage decimal? -
- startIndex decimal? -
- Resources ReadSingleUser[]? -
saps4hana.pp.idm: ReadSingleUser![](/images/permalink.svg)
Fields
- schemas string[]? -
- meta UserMeta? -
- id string? -
- userName string? -
- displayName string? -
- active boolean? -
- emails Emails[]? -
saps4hana.pp.idm: Success204![](/images/permalink.svg)
Fields
- body Success204Body -
saps4hana.pp.idm: Success204Body![](/images/permalink.svg)
Fields
- status int -
- message string -
saps4hana.pp.idm: User![](/images/permalink.svg)
Fields
- id string -
- userName string? -
- displayName string -
- active boolean -
- emails Emails[]? -
saps4hana.pp.idm: UserMeta![](/images/permalink.svg)
Fields
- resourceType string? -
- created string? -
- lastModified string? -
- location string? -
Import
import ballerinax/saps4hana.pp.idm;
Metadata
Released date: over 1 year ago
Version: 1.4.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Business Management/ERP
Cost/Paid
Contributors
Dependencies