Add new providerScim

POST

/v1/organizations/:organizationId/providers/:providerId/scim/

Add new providerScim

Required Permission: base.organization.scim.create

Add new providerScim

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

providerId string

required

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

Body Params application/json

config object optional

collaborator object optional

create object optional

action string required

createWithRole nothing

createWithRole string optional

admin editor viewer unassigned

deactivate object optional

action string required

remove nothing unassign

employee object optional

create object optional

action string required

create nothing

deactivate object optional

action string required

remove nothing

mdmUser object optional

create object optional

action string required

create nothing

deactivate object optional

action string required

unassign changePolicy removeMdmUser removeMdmUserAndDevices nothing

changePolicy object optional

winPolicyId string optional

Match pattern: ^[a-fA-F0-9]{24}$

admPolicyIdMacos string optional

Match pattern: ^[a-fA-F0-9]{24}$

admPolicyIdIos string optional

Match pattern: ^[a-fA-F0-9]{24}$

emmPolicyId string optional

Match pattern: ^[a-fA-F0-9]{24}$

winPolicyAssignments array [object] optional

admPolicyAssignmentsMacos array [object] optional

admPolicyAssignmentsIos array [object] optional

emmPolicyAssignments array [object] optional

mappedAttributes array [object] optional

name string required

≤ 256 characters

attributes array [object] optional

namespace string optional

≤ 256 characters

key string required

≤ 256 characters

{
    "config": {
        "collaborator": {
            "create": {
                "action": "createWithRole",
                "createWithRole": "admin"
            },
            "deactivate": {
                "action": "remove"
            }
        },
        "employee": {
            "create": {
                "action": "create"
            },
            "deactivate": {
                "action": "remove"
            }
        },
        "mdmUser": {
            "create": {
                "action": "create"
            },
            "deactivate": {
                "action": "unassign",
                "changePolicy": {
                    "winPolicyId": "string",
                    "admPolicyIdMacos": "string",
                    "admPolicyIdIos": "string",
                    "emmPolicyId": "string",
                    "winPolicyAssignments": [
                        {
                            "winPolicyId": "string",
                            "priority": 0
                        }
                    ],
                    "admPolicyAssignmentsMacos": [
                        {
                            "admPolicyId": "string",
                            "priority": 0
                        }
                    ],
                    "admPolicyAssignmentsIos": [
                        {
                            "admPolicyId": "string",
                            "priority": 0
                        }
                    ],
                    "emmPolicyAssignments": [
                        {
                            "emmPolicyId": "string",
                            "priority": 0
                        }
                    ]
                }
            }
        }
    },
    "mappedAttributes": [
        {
            "name": "string",
            "attributes": [
                {
                    "namespace": "string",
                    "key": "string"
                }
            ]
        }
    ]
}

Responses

200 Response application/json

status boolean optional

data object optional

bearer string optional

≤ 256 characters

config object optional

collaborator object optional

create object optional

action string required

createWithRole nothing

createWithRole string optional

admin editor viewer unassigned

deactivate object optional

action string required

remove nothing unassign

employee object optional

create object optional

action string required

create nothing

deactivate object optional

action string required

remove nothing

mdmUser object optional

create object optional

action string required

create nothing

deactivate object optional

action string required

unassign changePolicy removeMdmUser removeMdmUserAndDevices nothing

changePolicy object optional

mappedAttributes array [object] optional

name string required

≤ 256 characters

attributes array [object] optional

namespace string optional

≤ 256 characters

key string required

≤ 256 characters

attributesHistory array [object] optional

namespace string required

≤ 256 characters

key string required

≤ 256 characters

{
    "status": true,
    "data": {
        "bearer": "string",
        "config": {
            "collaborator": {
                "create": {
                    "action": "createWithRole",
                    "createWithRole": "admin"
                },
                "deactivate": {
                    "action": "remove"
                }
            },
            "employee": {
                "create": {
                    "action": "create"
                },
                "deactivate": {
                    "action": "remove"
                }
            },
            "mdmUser": {
                "create": {
                    "action": "create"
                },
                "deactivate": {
                    "action": "unassign",
                    "changePolicy": {
                        "winPolicyId": "string",
                        "admPolicyIdMacos": "string",
                        "admPolicyIdIos": "string",
                        "emmPolicyId": "string",
                        "winPolicyAssignments": [
                            {
                                "winPolicyId": "string",
                                "priority": 0
                            }
                        ],
                        "admPolicyAssignmentsMacos": [
                            {
                                "admPolicyId": "string",
                                "priority": 0
                            }
                        ],
                        "admPolicyAssignmentsIos": [
                            {
                                "admPolicyId": "string",
                                "priority": 0
                            }
                        ],
                        "emmPolicyAssignments": [
                            {
                                "emmPolicyId": "string",
                                "priority": 0
                            }
                        ]
                    }
                }
            }
        },
        "mappedAttributes": [
            {
                "name": "string",
                "attributes": [
                    {
                        "namespace": "string",
                        "key": "string"
                    }
                ]
            }
        ],
        "attributesHistory": [
            {
                "namespace": "string",
                "key": "string"
            }
        ]
    }
}

400 Response application/json

status boolean optional

false

error object optional

code number optional

5091

message string optional

Invalid data

{
    "status": false,
    "error": {
        "code": 5091,
        "message": "Invalid data"
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}