1. REST API for Oracle Digital Experience for Communications Industry Fabric
  2. Tasks
  3. Administration
  4. SCIM Configurations

Replace a SCIM configuration

put

/admin/scimConfigurations/{id}

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Match One Schema
Show Source
Nested Schema : profiles
Type: object
Additional Properties Allowed
Show Source
Nested Schema : additionalProperties
Type: object
Show Source
Nested Schema : group-assignment
Type: array
Show Source
Nested Schema : scim-custom-attr-mapping
Type: object
Additional Properties Allowed
Show Source
Nested Schema : scim-rfc7643-mapping
Type: object
Additional Properties Allowed
Show Source
  • Default Value: FORWARD
    Allowed Values: [ "FORWARD", "SWALLOW" ]
Nested Schema : additionalProperties
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Match One Schema
Show Source
Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : SCIMConfiguration
Type: object
Show Source
Match One Schema
Show Source
Nested Schema : profiles
Type: object
Additional Properties Allowed
Show Source
Nested Schema : additionalProperties
Type: object
Show Source
Nested Schema : group-assignment
Type: array
Show Source
Nested Schema : scim-custom-attr-mapping
Type: object
Additional Properties Allowed
Show Source
Nested Schema : scim-rfc7643-mapping
Type: object
Additional Properties Allowed
Show Source
  • Default Value: FORWARD
    Allowed Values: [ "FORWARD", "SWALLOW" ]
Nested Schema : additionalProperties
Type: array
Show Source
Nested Schema : items
Type: object
Show Source
Match One Schema
Show Source

400 Response

Bad Request
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

401 Response

Unauthorized
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

403 Response

Forbidden
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

404 Response

Not Found
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

409 Response

Conflict
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source

500 Response

Internal Server Error
Body ()
Root Schema : Error
Type: object
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
Back to Top

Examples

The following example shows how to replace a scim configuration by submitting a PUT request on the REST resource using cURL.

cURL Command

curl -H 'Authorization: Bearer <Token>' -X PUT https://{FABRIC_HOST}/admin/scimConfigurations/{id} -H "Content-Type: application/json" -D replace_scimconfigurations.json | json_pp

Example of Request Body

The following shows an example of the request body in JSON format.

{
    "target-connection-descriptor-name": "flytxtjmbfz",
    "profiles": {
        "subscriber": {
            "group-assignment": [
                "oracleGroup"
            ],
            "scim-custom-attr-mapping": {
                "urn:scim:schemas:extension:custom:1.0:User": [
                    {
                        "attribute-name": "donot-forward-attr",
                        "mode": "SWALLOW"
                    },
                    {
                        "attribute-name": "pass-through-attr",
                        "mode": "FORWARD"
                    },
                    {
                        "attribute-name": "this-needs-to-be-mapped-attr",
                        "attribute-type": "DATETIMESTRING",
                        "required": true,
                        "mode": "MAP",
                        "target-attribute-name": "foo-target-attribute"
                    }
                ]
            },
            "scim-rfc7643-mapping": {
                "bar": "FORWARD",
                "foo": "SWALLOW",
                "name": "SWALLOW"
            }
        }
    }
}

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "target-connection-descriptor-name": "flytxtjmbfz",
    "target-connection-descriptor-namespace": "dx-prod",
    "profiles": {
        "subscriber": {
            "scim-rfc7643-mapping": {
                "bar": "FORWARD",
                "foo": "SWALLOW",
                "name": "SWALLOW"
            },
            "scim-custom-attr-mapping": {
                "urn:scim:schemas:extension:custom:1.0:User": [
                    {
                        "attribute-name": "donot-forward-attr",
                        "attribute-type": "STRING",
                        "required": false,
                        "mode": "SWALLOW"
                    },
                    {
                        "attribute-name": "pass-through-attr",
                        "attribute-type": "STRING",
                        "required": false,
                        "mode": "FORWARD"
                    },
                    {
                        "attribute-name": "this-needs-to-be-mapped-attr",
                        "attribute-type": "DATETIMESTRING",
                        "required": true,
                        "mode": "MAP",
                        "target-attribute-name": "foo-target-attribute"
                    }
                ]
            },
            "group-assignment": [
                "oracleGroup"
            ]
        }
    },
    "id": "flytxtjmbfz9cj2b",
    "target-connection-descriptor-href": "/connectionDescriptors/flytxtjmbfz"
}
Back to Top