saps4hana.pp.idm
Module saps4hana.pp.idm
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
saps4hana.pp.idm: Client
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
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
getAllUsers
function getAllUsers() returns ReadMultipleUsers[]|error
Retrieves all users.
Return Type
- ReadMultipleUsers[]|error - Retrieved entities.
addNewUser
Adds a new user.
Parameters
- payload User - User object
getUserById
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
Updates the user.
deleteUserById
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
saps4hana.pp.idm: ClientConfig
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.pp.idm: Emails
Fields
- value string -
- 'type string? -
- primary boolean? -
saps4hana.pp.idm: Error
Fields
- _error ErrorError -
saps4hana.pp.idm: Error400
Fields
- _error Error400Error -
saps4hana.pp.idm: Error400Error
Fields
- status int -
- message string -
saps4hana.pp.idm: Error401
Fields
- _error Error401Error -
saps4hana.pp.idm: Error401Error
Fields
- status int -
- message string -
saps4hana.pp.idm: Error403
Fields
- _error Error403Error -
saps4hana.pp.idm: Error403Error
Fields
- status int -
- message string -
saps4hana.pp.idm: Error404
Fields
- _error Error404Error -
saps4hana.pp.idm: Error404Error
Fields
- status int -
- message string -
saps4hana.pp.idm: Error405
Fields
- _error Error405Error -
saps4hana.pp.idm: Error405Error
Fields
- status int -
- message string -
saps4hana.pp.idm: Error406
Fields
- _error Error406Error -
saps4hana.pp.idm: Error406Error
Fields
- status int -
- message string -
saps4hana.pp.idm: Error409
Fields
- _error Error409Error -
saps4hana.pp.idm: Error409Error
Fields
- status int -
- message string -
saps4hana.pp.idm: ErrorError
Fields
- status int -
- message string -
saps4hana.pp.idm: ReadMultipleUsers
Fields
- schemas string[]? -
- totalResults decimal? -
- itemsPerPage decimal? -
- startIndex decimal? -
- Resources ReadSingleUser[]? -
saps4hana.pp.idm: ReadSingleUser
Fields
- schemas string[]? -
- meta UserMeta? -
- id string? -
- userName string? -
- displayName string? -
- active boolean? -
- emails Emails[]? -
saps4hana.pp.idm: Success204
Fields
- body Success204Body -
saps4hana.pp.idm: Success204Body
Fields
- status int -
- message string -
saps4hana.pp.idm: User
Fields
- id string -
- userName string? -
- displayName string -
- active boolean -
- emails Emails[]? -
saps4hana.pp.idm: UserMeta
Fields
- resourceType string? -
- created string? -
- lastModified string? -
- location string? -
Import
import ballerinax/saps4hana.pp.idm;
Metadata
Released date: over 2 years ago
Version: 1.0.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.0.0
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Business Management/ERP
Cost/Paid
Contributors
Dependencies