Criar educationUser

Artigo
10/28/2023

Namespace: microsoft.graph

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.

Crie um novo usuário.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global	Governo dos EUA L4	GOVERNO DOS EUA L5 (DOD)	China operada pela 21Vianet
✅	❌	❌	❌

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão	Permissões menos privilegiadas	Permissões privilegiadas mais altas
Delegado (conta corporativa ou de estudante)	Sem suporte.	Sem suporte.
Delegado (conta pessoal da Microsoft)	Sem suporte.	Sem suporte.
Aplicativo	EduRoster.ReadWrite.All	Indisponível.

Solicitação HTTP

POST /education/users

Cabeçalhos de solicitação

Cabeçalho	Valor
Autorização	{token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type	application/json

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON de um objeto educationUser.

Resposta

Se bem-sucedido, esse método retornará um código de resposta 201 Created e um objeto educationUser no corpo da resposta.

Exemplo

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/education/users
Content-type: application/json

{
  "displayName": "Dion Matheson",
  "givenName": "Dion",
  "middleName": null,
  "surname": "Matheson",
  "mail": "DionM@contoso.com",
  "mobilePhone": "+1 (253) 555-0101",
  "createdBy": {
    "user": {
      "displayName": "Susana Rocha",
      "id": "14012"
    }
  },
  "externalSource": "sis",
  "mailingAddress": {
    "city": "Los Angeles",
    "countryOrRegion": "United States",
    "postalCode": "98055",
    "state": "CA",
    "street": "12345 Main St."
  },
  "primaryRole": "student",
  "residenceAddress": {
    "city": "Los Angeles",
    "countryOrRegion": "United States",
    "postalCode": "98055",
    "state": "CA",
    "street": "12345 Main St."
  }
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new EducationUser
{
	DisplayName = "Dion Matheson",
	GivenName = "Dion",
	MiddleName = null,
	Surname = "Matheson",
	Mail = "DionM@contoso.com",
	MobilePhone = "+1 (253) 555-0101",
	CreatedBy = new IdentitySet
	{
		User = new Identity
		{
			DisplayName = "Susana Rocha",
			Id = "14012",
		},
	},
	ExternalSource = EducationExternalSource.Sis,
	MailingAddress = new PhysicalAddress
	{
		City = "Los Angeles",
		CountryOrRegion = "United States",
		PostalCode = "98055",
		State = "CA",
		Street = "12345 Main St.",
	},
	PrimaryRole = EducationUserRole.Student,
	ResidenceAddress = new PhysicalAddress
	{
		City = "Los Angeles",
		CountryOrRegion = "United States",
		PostalCode = "98055",
		State = "CA",
		Street = "12345 Main St.",
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Education.Users.PostAsync(requestBody);

Importante

Os SDKs do Microsoft Graph usam a versão v1.0 da API por padrão e não oferecem suporte a todos os tipos, propriedades e APIs disponíveis na versão beta. Para obter detalhes sobre como acessar a API beta com o SDK, consulte Usar os SDKs do Microsoft Graph com a API beta.

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.



mgc-beta education users create --body '{\
  "displayName": "Dion Matheson",\
  "givenName": "Dion",\
  "middleName": null,\
  "surname": "Matheson",\
  "mail": "DionM@contoso.com",\
  "mobilePhone": "+1 (253) 555-0101",\
  "createdBy": {\
    "user": {\
      "displayName": "Susana Rocha",\
      "id": "14012"\
    }\
  },\
  "externalSource": "sis",\
  "mailingAddress": {\
    "city": "Los Angeles",\
    "countryOrRegion": "United States",\
    "postalCode": "98055",\
    "state": "CA",\
    "street": "12345 Main St."\
  },\
  "primaryRole": "student",\
  "residenceAddress": {\
    "city": "Los Angeles",\
    "countryOrRegion": "United States",\
    "postalCode": "98055",\
    "state": "CA",\
    "street": "12345 Main St."\
  }\
}\
'

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewEducationUser()
displayName := "Dion Matheson"
requestBody.SetDisplayName(&displayName) 
givenName := "Dion"
requestBody.SetGivenName(&givenName) 
middleName := null
requestBody.SetMiddleName(&middleName) 
surname := "Matheson"
requestBody.SetSurname(&surname) 
mail := "DionM@contoso.com"
requestBody.SetMail(&mail) 
mobilePhone := "+1 (253) 555-0101"
requestBody.SetMobilePhone(&mobilePhone) 
createdBy := graphmodels.NewIdentitySet()
user := graphmodels.NewIdentity()
displayName := "Susana Rocha"
user.SetDisplayName(&displayName) 
id := "14012"
user.SetId(&id) 
createdBy.SetUser(user)
requestBody.SetCreatedBy(createdBy)
externalSource := graphmodels.SIS_EDUCATIONEXTERNALSOURCE 
requestBody.SetExternalSource(&externalSource) 
mailingAddress := graphmodels.NewPhysicalAddress()
city := "Los Angeles"
mailingAddress.SetCity(&city) 
countryOrRegion := "United States"
mailingAddress.SetCountryOrRegion(&countryOrRegion) 
postalCode := "98055"
mailingAddress.SetPostalCode(&postalCode) 
state := "CA"
mailingAddress.SetState(&state) 
street := "12345 Main St."
mailingAddress.SetStreet(&street) 
requestBody.SetMailingAddress(mailingAddress)
primaryRole := graphmodels.STUDENT_EDUCATIONUSERROLE 
requestBody.SetPrimaryRole(&primaryRole) 
residenceAddress := graphmodels.NewPhysicalAddress()
city := "Los Angeles"
residenceAddress.SetCity(&city) 
countryOrRegion := "United States"
residenceAddress.SetCountryOrRegion(&countryOrRegion) 
postalCode := "98055"
residenceAddress.SetPostalCode(&postalCode) 
state := "CA"
residenceAddress.SetState(&state) 
street := "12345 Main St."
residenceAddress.SetStreet(&street) 
requestBody.SetResidenceAddress(residenceAddress)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
users, err := graphClient.Education().Users().Post(context.Background(), requestBody, nil)

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

EducationUser educationUser = new EducationUser();
educationUser.setDisplayName("Dion Matheson");
educationUser.setGivenName("Dion");
educationUser.setMiddleName(null);
educationUser.setSurname("Matheson");
educationUser.setMail("DionM@contoso.com");
educationUser.setMobilePhone("+1 (253) 555-0101");
IdentitySet createdBy = new IdentitySet();
Identity user = new Identity();
user.setDisplayName("Susana Rocha");
user.setId("14012");
createdBy.setUser(user);
educationUser.setCreatedBy(createdBy);
educationUser.setExternalSource(EducationExternalSource.Sis);
PhysicalAddress mailingAddress = new PhysicalAddress();
mailingAddress.setCity("Los Angeles");
mailingAddress.setCountryOrRegion("United States");
mailingAddress.setPostalCode("98055");
mailingAddress.setState("CA");
mailingAddress.setStreet("12345 Main St.");
educationUser.setMailingAddress(mailingAddress);
educationUser.setPrimaryRole(EducationUserRole.Student);
PhysicalAddress residenceAddress = new PhysicalAddress();
residenceAddress.setCity("Los Angeles");
residenceAddress.setCountryOrRegion("United States");
residenceAddress.setPostalCode("98055");
residenceAddress.setState("CA");
residenceAddress.setStreet("12345 Main St.");
educationUser.setResidenceAddress(residenceAddress);
EducationUser result = graphClient.education().users().post(educationUser);

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

const educationUser = {
  displayName: 'Dion Matheson',
  givenName: 'Dion',
  middleName: null,
  surname: 'Matheson',
  mail: 'DionM@contoso.com',
  mobilePhone: '+1 (253) 555-0101',
  createdBy: {
    user: {
      displayName: 'Susana Rocha',
      id: '14012'
    }
  },
  externalSource: 'sis',
  mailingAddress: {
    city: 'Los Angeles',
    countryOrRegion: 'United States',
    postalCode: '98055',
    state: 'CA',
    street: '12345 Main St.'
  },
  primaryRole: 'student',
  residenceAddress: {
    city: 'Los Angeles',
    countryOrRegion: 'United States',
    postalCode: '98055',
    state: 'CA',
    street: '12345 Main St.'
  }
};

await client.api('/education/users')
	.version('beta')
	.post(educationUser);

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\EducationUser;
use Microsoft\Graph\Beta\Generated\Models\IdentitySet;
use Microsoft\Graph\Beta\Generated\Models\Identity;
use Microsoft\Graph\Beta\Generated\Models\ExternalSource;
use Microsoft\Graph\Beta\Generated\Models\PhysicalAddress;
use Microsoft\Graph\Beta\Generated\Models\PrimaryRole;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new EducationUser();
$requestBody->setDisplayName('Dion Matheson');
$requestBody->setGivenName('Dion');
$requestBody->setMiddleName(null);
$requestBody->setSurname('Matheson');
$requestBody->setMail('DionM@contoso.com');
$requestBody->setMobilePhone('+1 (253) 555-0101');
$createdBy = new IdentitySet();
$createdByUser = new Identity();
$createdByUser->setDisplayName('Susana Rocha');
$createdByUser->setId('14012');
$createdBy->setUser($createdByUser);
$requestBody->setCreatedBy($createdBy);
$requestBody->setExternalSource(new EducationExternalSource('sis'));
$mailingAddress = new PhysicalAddress();
$mailingAddress->setCity('Los Angeles');
$mailingAddress->setCountryOrRegion('United States');
$mailingAddress->setPostalCode('98055');
$mailingAddress->setState('CA');
$mailingAddress->setStreet('12345 Main St.');
$requestBody->setMailingAddress($mailingAddress);
$requestBody->setPrimaryRole(new EducationUserRole('student'));
$residenceAddress = new PhysicalAddress();
$residenceAddress->setCity('Los Angeles');
$residenceAddress->setCountryOrRegion('United States');
$residenceAddress->setPostalCode('98055');
$residenceAddress->setState('CA');
$residenceAddress->setStreet('12345 Main St.');
$requestBody->setResidenceAddress($residenceAddress);

$result = $graphServiceClient->education()->users()->post($requestBody)->wait();

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


Import-Module Microsoft.Graph.Beta.Education

$params = @{
	displayName = "Dion Matheson"
	givenName = "Dion"
	middleName = $null
	surname = "Matheson"
	mail = "DionM@contoso.com"
	mobilePhone = "+1 (253) 555-0101"
	createdBy = @{
		user = @{
			displayName = "Susana Rocha"
			id = "14012"
		}
	}
	externalSource = "sis"
	mailingAddress = @{
		city = "Los Angeles"
		countryOrRegion = "United States"
		postalCode = "98055"
		state = "CA"
		street = "12345 Main St."
	}
	primaryRole = "student"
	residenceAddress = @{
		city = "Los Angeles"
		countryOrRegion = "United States"
		postalCode = "98055"
		state = "CA"
		street = "12345 Main St."
	}
}

New-MgBetaEducationUser -BodyParameter $params

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.


from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.education_user import EducationUser
from msgraph_beta.generated.models.identity_set import IdentitySet
from msgraph_beta.generated.models.identity import Identity
from msgraph_beta.generated.models.education_external_source import EducationExternalSource
from msgraph_beta.generated.models.physical_address import PhysicalAddress
from msgraph_beta.generated.models.education_user_role import EducationUserRole

graph_client = GraphServiceClient(credentials, scopes)

request_body = EducationUser(
	display_name = "Dion Matheson",
	given_name = "Dion",
	middle_name = None,
	surname = "Matheson",
	mail = "DionM@contoso.com",
	mobile_phone = "+1 (253) 555-0101",
	created_by = IdentitySet(
		user = Identity(
			display_name = "Susana Rocha",
			id = "14012",
		),
	),
	external_source = EducationExternalSource.Sis,
	mailing_address = PhysicalAddress(
		city = "Los Angeles",
		country_or_region = "United States",
		postal_code = "98055",
		state = "CA",
		street = "12345 Main St.",
	),
	primary_role = EducationUserRole.Student,
	residence_address = PhysicalAddress(
		city = "Los Angeles",
		country_or_region = "United States",
		postal_code = "98055",
		state = "CA",
		street = "12345 Main St.",
	),
)

result = await graph_client.education.users.post(request_body)

Importante

Para obter detalhes sobre como adicionar o SDK ao seu projeto e criar uma instância authProvider, consulte a documentação do SDK.

Resposta

O exemplo a seguir mostra a resposta.

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

HTTP/1.1 201 Created
Content-type: application/json

{
  "id": "13012",
  "displayName": "Dion Matheson",
  "givenName": "Dion",
  "middleName": " ",
  "surname": "Matheson",
  "mail": "DionM@contoso.com",
  "mobilePhone": "+1 (253) 555-0101",
  "createdBy": {
    "user": {
      "displayName": "Susana Rocha",
      "id": "14012",
    }
  },
  "externalSource": "sis",
  "mailingAddress": {
    "city": "Los Angeles",
    "countryOrRegion": "United States",
    "postalCode": "98055",
    "state": "CA",
    "street": "12345 Main St."
  },
  "primaryRole": "student",
  "residenceAddress": {
    "city": "Los Angeles",
    "countryOrRegion": "United States",
    "postalCode": "98055",
    "state": "CA",
    "street": "12345 Main St."
  }
}

Compartilhar via

Criar educationUser

Permissões

Solicitação HTTP

Cabeçalhos de solicitação

Corpo da solicitação

Resposta

Exemplo

Solicitação

Resposta

Comentários

Comentários

Recursos adicionais