Get all SCIM configurations
get
/admin/scimConfigurations
Request
Query Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
OK
Nested Schema : SCIMConfiguration
Type:
Show Source
object-
id: string
-
profiles: object
profiles
Additional Properties Allowed: additionalProperties
-
target-connection-descriptor-href: string
-
target-connection-descriptor-name: string
-
target-connection-descriptor-namespace: string
Match One Schema
Show Source
Nested Schema : additionalProperties
Type:
Show Source
object-
group-assignment: array
group-assignment
-
scim-custom-attr-mapping: object
scim-custom-attr-mapping
Additional Properties Allowed: additionalProperties
-
scim-rfc7643-mapping: object
scim-rfc7643-mapping
Additional Properties Allowed: additionalProperties
Nested Schema : scim-rfc7643-mapping
Type:
objectAdditional Properties Allowed
Show Source
-
string
Default Value:
FORWARDAllowed Values:[ "FORWARD", "SWALLOW" ]
Nested Schema : items
Type:
Show Source
object-
attribute-name: string
-
attribute-type: string
Default Value:
STRINGAllowed Values:[ "STRING", "NUMBER", "INTEGER", "BOOLEAN", "DATETIMESTRING" ] -
mode: string
Default Value:
FORWARDAllowed Values:[ "FORWARD", "SWALLOW", "MAP" ] -
required: boolean
Default Value:
false -
target-attribute-name: string
Match One Schema
Show Source
400 Response
Bad Request
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
401 Response
Unauthorized
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
403 Response
Forbidden
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
404 Response
Not Found
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
500 Response
Internal Server Error
Root Schema : Error
Type:
objectUsed when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
Show Source
-
@baseType: string
When sub-classing, this defines the super-class.
-
@schemaLocation: string
(uri)
A URI to a JSON-Schema file that defines additional attributes and relationships
-
@type: string
When sub-classing, this defines the sub-class entity name.
-
code(required): string
Application relevant detail, defined in the API or a common list.
-
message: string
More details and corrective actions related to the error which can be shown to a client user.
-
reason(required): string
Explanation of the reason for the error which can be shown to a client user.
-
referenceError: string
(uri)
URI of documentation describing the error.
-
status: string
HTTP Error code extension
Examples
The following example shows how to get all scim configurations by submitting a GET request on the REST resource using cURL.
cURL Command
curl -H 'Authorization: Bearer <Token>' -X GET
https://{FABRIC_HOST}/admin/scimConfigurations -H
"Content-Type: application/json" | json_pp
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"
}