Create external system information and its credentials set.
You need to provide the SystemId (unique within the integration package) and the SystemType. You can retrieve them
You also need to provide the credentials. These are system properties (different for each system type). You can retrieve them
Authentication
Requires Authorization header with valid Bearer token for scope itwin-platform.
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
Authorization
User must have the edfs_credmng permission assigned at the iTwin level or be an Organization Administrator for the Organization that owns a given iTwin.
Request parameters
The iTwin project ID
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Request body
SaveUserSystemCredentialDto
The name of the system
Example
{ "name": "Development Sql Server", "systemId": "dev_sql_server", "systemType": "EDF.Sql", "credentials": { "Server": "dbserver.somewhere.com", "Database": "my-db", "UserId": "myuser", "Password": "P@$$w0rd", "IntegratedSecurity": "false", "CommandTimeout": "30" } }
Response 201 Created
Created
{ "id": "00000000-0000-0000-0000-000000000000", "systemName": "Development Sql Server", "systemId": "devsqlserver", "systemType": "EDF.Sql" }
Response 401 Unauthorized
This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 403 Forbidden
The user has insufficient permissions for the requested operation.
{ "error": { "code": "InsufficientPermissions", "message": "The user has insufficient permissions for the requested operation." } }
Response 409 Conflict
This response indicates that the user tried to create a resource that already exists.
{ "error": { "code": "SystemExists", "message": "A system with the same parameters already exists.", "details": [{ "code": "InvalidValue", "message": "A system with the specified SystemId already exists.", "target": "SystemId" }] } }
Response 422 Unprocessable Entity
The 422 (Unprocessable Entity) status code indicates that the request cannot be processed by the server due to a client error (e.g. malformed request syntax)
{ "error": { "code": "InvalidSystemRequest", "message": "Cannot create System.", "details": [{ "code": "InvalidValue", "message": "Provided System ID value contains invalid characters.", "target": "SystemId" }, { "code": "MissingRequiredProperty", "message": "Required property Name is missing.", "target": "Name" }, { "code": "InvalidValue", "message": "Provided System Type value exceeds maximum length 150.", "target": "SystemType" }, { "code": "InvalidValue", "message": "Provided Credentials value contains invalid characters.", "target": "Credentials" }, { "code": "InvalidValue", "message": "Provided iTwin ID value is not valid.", "target": "iTwinId" } ] } }
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
Response headers
The number of requests exceeds the rate-limit for the client subscription.
SaveUserSystemCredentialDto
The name of the system
{ "type": "object", "properties": { "name": { "maxLength": 200, "type": "string", "description": "The name of the system" }, "systemId": { "maxLength": 200, "type": "string", "description": "The [system ID](/apis/edfs/operations/system-types-get/)" }, "systemType": { "maxLength": 150, "type": "string", "description": "The [system type](/apis/edfs/operations/system-types-get/)" }, "credentials": { "type": "object", "additionalProperties": { "type": "string" }, "description": "The system [credential properties](/apis/edfs/operations/system-type-properties-get/)" } }, "additionalProperties": false }
SystemCredentialDto
The friendly name of the external system
{ "type": "object", "properties": { "id": { "type": "string" }, "systemName": { "type": "string", "description": "The friendly name of the external system" }, "systemId": { "type": "string", "description": "The [system ID](/apis/edfs/operations/system-types-get/)" }, "systemType": { "type": "string", "description": "The [system type](/apis/edfs/operations/system-types-get/)" } }, "additionalProperties": false }
DetailedError
Contains error information and an array of more specific errors.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
{ "type": "object", "description": "Contains error information and an array of more specific errors.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error.", "nullable": true }, "details": { "type": "array", "description": "Optional array of more specific errors.", "items": { "$ref": "#/components/schemas/Error" } } }, "required": [ "code", "message", "details" ], "additionalProperties": true }
Detailed Error Response
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.
{ "type": "object", "title": "Detailed Error Response", "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.", "properties": { "error": { "description": "Error Detailed information.", "$ref": "#/components/schemas/DetailedError" } }, "required": [ "error" ], "additionalProperties": false }
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
{ "type": "object", "description": "Contains error information.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error.", "nullable": true } }, "required": [ "code", "message" ], "additionalProperties": true }
Error Response
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.
{ "type": "object", "title": "Error Response", "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.", "properties": { "error": { "description": "Error information.", "$ref": "#/components/schemas/Error" } }, "required": [ "error" ], "additionalProperties": false }
Was this page helpful?