Compartilhar via


Listar objetos provisioningFlow

Espaço de nomes: microsoft.graph.industryData

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Obtenha uma lista dos objetos provisioningFlow e respetivas propriedades.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissão com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) IndustryData-OutboundFlow.Read.All IndustryData-OutboundFlow.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application IndustryData-OutboundFlow.Read.All IndustryData-OutboundFlow.ReadWrite.All

Solicitação HTTP

GET /external/industryData/outboundProvisioningFlowSets/{id}/provisioningFlows

Parâmetros de consulta opcionais

Este método dá suporte a alguns parâmetros de consulta OData para ajudar a personalizar a resposta. Para obter informações gerais, acesse Parâmetros de consulta OData.

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.

Corpo da solicitação

Não forneça um corpo de solicitação para esse método.

Resposta

Se for bem-sucedido, este método devolve um 200 OK código de resposta e uma coleção de objetos provisioningFlow no corpo da resposta.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

GET https://graph.microsoft.com/beta/external/industryData/outboundProvisioningFlowSets/8c33d025-5e64-4550-2aa3-08dc4ac66fca/provisioningFlows

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('8c33d025-5e64-4550-2aa3-08dc4ac66fca')/provisioningFlows",
    "value": [
        {
            "@odata.type": "#microsoft.graph.industryData.securityGroupProvisioningFlow",
            "id": "51f99e09-bdc5-47ff-7a0a-08dc4ac74cf1",
            "createdDateTime": "2024-03-25T22:29:22.6303479Z",
            "lastModifiedDateTime": "2024-03-25T22:29:22.6303479Z",
            "readinessStatus": "disabled",
            "creationOptions": {
                "createBasedOnRoleGroup": true,
                "createBasedOnOrgPlusRoleGroup": false
            }
        },
        {
            "@odata.type": "#microsoft.graph.industryData.classGroupProvisioningFlow",
            "id": "6207e7d7-5eba-4ddc-e607-08dc4ac77409",
            "createdDateTime": "2024-03-25T22:29:16.1177912Z",
            "lastModifiedDateTime": "2024-03-25T22:29:16.1177912Z",
            "readinessStatus": "disabled",
            "configuration": {
                "additionalAttributes": [
                    "courseTitle",
                    "courseCode",
                    "courseSubject",
                    "courseGradeLevel",
                    "courseExternalId",
                    "academicSessionTitle",
                    "academicSessionExternalId"
                ],
                "additionalOptions": {
                    "createTeam": true,
                    "writeDisplayNameOnCreateOnly": true
                },
                "enrollmentMappings": {
                    "ownerEnrollmentMappings": [
                        {
                            "code": "teacher"
                        },
                        {
                            "code": "proctor"
                        },
                        {
                            "code": "teacherAssistant"
                        },
                        {
                            "code": "paraprofessional"
                        },
                        {
                            "code": "physicalTherapist"
                        },
                        {
                            "code": "speechTherapist"
                        },
                        {
                            "code": "visionTherapist"
                        },
                        {
                            "code": "occupationalTherapist"
                        },
                        {
                            "code": "staff"
                        }
                    ],
                    "memberEnrollmentMappings": [
                        {
                            "code": "student"
                        },
                        {
                            "code": "substitute"
                        },
                        {
                            "code": "aide"
                        },
                        {
                            "code": "proctor"
                        },
                        {
                            "code": "teacherAssistant"
                        },
                        {
                            "code": "paraprofessional"
                        },
                        {
                            "code": "physicalTherapist"
                        },
                        {
                            "code": "speechTherapist"
                        },
                        {
                            "code": "visionTherapist"
                        },
                        {
                            "code": "occupationalTherapist"
                        },
                        {
                            "code": "staff"
                        }
                    ]
                }
            }
        },
        {
            "@odata.type": "#microsoft.graph.industryData.administrativeUnitProvisioningFlow",
            "id": "7b355e84-0af2-42fd-d392-08dc4ac68cf2",
            "createdDateTime": "2024-03-25T22:29:05.4272368Z",
            "lastModifiedDateTime": "2024-03-25T22:29:05.4272368Z",
            "readinessStatus": "disabled",
            "creationOptions": {
                "createBasedOnOrg": true,
                "createBasedOnOrgPlusRoleGroup": true
            }
        },
        {
            "@odata.type": "#microsoft.graph.industryData.userProvisioningFlow",
            "id": "dfeec276-d507-4008-d393-08dc4ac68cf2",
            "createdDateTime": "2024-03-25T22:29:10.0687495Z",
            "lastModifiedDateTime": "2024-03-25T22:29:10.0687495Z",
            "readinessStatus": "disabled",
            "createUnmatchedUsers": true,
            "managementOptions": {
                "additionalAttributes": [
                    "userGradeLevel"
                ],
                "additionalOptions": {
                    "markAllStudentsAsMinors": true,
                    "allowStudentContactAssociation": false
                }
            },
            "creationOptions": {
                "configurations": [
                    {
                        "licenseSkus": [
                            "world-class"
                        ],
                        "defaultPasswordSettings": {
                            "@odata.type": "#microsoft.graph.industryData.simplePasswordSettings",
                            "password": "***************"
                        },
                        "roleGroup@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('8c33d025-5e64-4550-2aa3-08dc4ac66fca')/provisioningFlows('dfeec276-d507-4008-d393-08dc4ac68cf2')/microsoft.graph.industryData.userProvisioningFlow/creationOptions/configurations/roleGroup/$entity",
                        "roleGroup": {
                            "id": "students",
                            "displayName": "Students",
                            "roles": [
                                {
                                    "code": "student"
                                }
                            ]
                        }
                    },
                    {
                        "licenseSkus": [
                            "Strategist"
                        ],
                        "defaultPasswordSettings": {
                            "@odata.type": "#microsoft.graph.industryData.simplePasswordSettings",
                            "password": "***************"
                        },
                        "roleGroup@odata.context": "https://graph.microsoft.com/beta/$metadata#external/industryData/outboundProvisioningFlowSets('8c33d025-5e64-4550-2aa3-08dc4ac66fca')/provisioningFlows('dfeec276-d507-4008-d393-08dc4ac68cf2')/microsoft.graph.industryData.userProvisioningFlow/creationOptions/configurations/roleGroup/$entity",
                        "roleGroup": {
                            "id": "staff",
                            "displayName": "Staff",
                            "roles": [
                                {
                                    "code": "adjunct"
                                },
                                {
                                    "code": "administrator"
                                },
                                {
                                    "code": "advisor"
                                },
                                {
                                    "code": "affiliate"
                                },
                                {
                                    "code": "aide"
                                },
                                {
                                    "code": "alumni"
                                },
                                {
                                    "code": "assistant"
                                },
                                {
                                    "code": "chair"
                                },
                                {
                                    "code": "coach"
                                },
                                {
                                    "code": "faculty"
                                },
                                {
                                    "code": "instructor"
                                },
                                {
                                    "code": "itAdmin"
                                },
                                {
                                    "code": "lecturer"
                                },
                                {
                                    "code": "nurse"
                                },
                                {
                                    "code": "occupationalTherapist"
                                },
                                {
                                    "code": "officeStaff"
                                },
                                {
                                    "code": "paraprofessional"
                                },
                                {
                                    "code": "physicalTherapist"
                                },
                                {
                                    "code": "principal"
                                },
                                {
                                    "code": "proctor"
                                },
                                {
                                    "code": "professor"
                                },
                                {
                                    "code": "researcher"
                                },
                                {
                                    "code": "specialServices"
                                },
                                {
                                    "code": "speechTherapist"
                                },
                                {
                                    "code": "staff"
                                },
                                {
                                    "code": "substitute"
                                },
                                {
                                    "code": "teacher"
                                },
                                {
                                    "code": "teacherAssistant"
                                },
                                {
                                    "code": "visionTherapist"
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ]
}