Get provider by ID

GET

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

Get provider by ID

Required Permission: base.organization.loginProvider.get

Get provider by ID

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

providerId string

required

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

Responses

200 Response application/json

status boolean required

data object required

id string required

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

organization string required

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

type string required

ldap saml google social

target string required

sdk dashboard store mdm

config object optional

supportMergeSSOEmployeesWithSSOUsers boolean optional

defaultRole string optional

owner admin editor viewer unassigned

loginButtonText string optional

ldap object optional

url string required

≤ 500 characters

bindDN string required

≤ 128 characters

searchBase string required

≤ 128 characters

searchFilter string required

≤ 128 characters

attributes object required

email array [string] required

firstName array [string] required

lastName array [string] required

saml object optional

idpXml string required

attributes object required

email array [string] required

firstName array [string] required

lastName array [string] required

userName array [string] required

groups array [string] required

metadata array [object] required

name string required

≤ 128 characters

attributes array [string] required

google object optional

appId string required

≤ 500 characters

clientSecret string required

≤ 500 characters

domains array required

accessTokenGroups boolean required

groups array optional

social object optional

google boolean optional

tags array [object] optional

original string required

≤ 256 characters

translation string required

≤ 256 characters

scim object optional

bearer string optional

≤ 256 characters

config object required

collaborator object optional

create object optional

deactivate object optional

employee object optional

create object optional

deactivate object optional

mdmUser object optional

create object optional

deactivate object optional

attributes 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

createdBy string required

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

updatedAt string required

createdAt string required

{
    "status": true,
    "data": {
        "id": "string",
        "organization": "string",
        "type": "ldap",
        "target": "sdk",
        "config": {
            "supportMergeSSOEmployeesWithSSOUsers": true,
            "defaultRole": "owner",
            "loginButtonText": "string"
        },
        "ldap": {
            "url": "string",
            "bindDN": "string",
            "searchBase": "string",
            "searchFilter": "string",
            "attributes": {
                "email": [
                    "string"
                ],
                "firstName": [
                    "string"
                ],
                "lastName": [
                    "string"
                ]
            }
        },
        "saml": {
            "idpXml": "string",
            "attributes": {
                "email": [
                    "string"
                ],
                "firstName": [
                    "string"
                ],
                "lastName": [
                    "string"
                ],
                "userName": [
                    "string"
                ],
                "groups": [
                    "string"
                ],
                "metadata": [
                    {
                        "name": "string",
                        "attributes": [
                            "string"
                        ]
                    }
                ]
            }
        },
        "google": {
            "appId": "string",
            "clientSecret": "string",
            "domains": [
                "string"
            ],
            "accessTokenGroups": true,
            "groups": [
                "string"
            ]
        },
        "social": {
            "google": true
        },
        "tags": [
            {
                "original": "string",
                "translation": "string"
            }
        ],
        "scim": {
            "bearer": "string",
            "config": {
                "collaborator": {
                    "create": {
                        "action": "createWithRole",
                        "createWithRole": "owner"
                    },
                    "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
                                }
                            ]
                        }
                    }
                }
            },
            "attributes": [
                {
                    "name": "string",
                    "attributes": [
                        {
                            "namespace": "string",
                            "key": "string"
                        }
                    ]
                }
            ],
            "attributesHistory": [
                {
                    "namespace": "string",
                    "key": "string"
                }
            ]
        },
        "createdBy": "string",
        "updatedAt": "string",
        "createdAt": "string"
    }
}

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"
    }
}