Users - Create

Service:: IoT Central

API-versie:: 2022-07-31

Een gebruiker maken in de toepassing

PUT https://{subdomain}.{baseDomain}/api/users/{userId}?api-version=2022-07-31

URI-parameters

Name	In	Vereist	Type	Description
baseDomain	path	True	string	Het basisdomein voor alle Azure IoT Central-serviceaanvragen.
subdomain	path	True	string	Het subdomein van de toepassing.
userId	path	True	string maxLength: 48 pattern: ^[a-zA-Z0-9-_]*$	Unieke id voor de gebruiker.
api-version	query	True	string	De versie van de API die wordt aangeroepen.

Aanvraagbody

De aanvraagtekst kan een van de volgende zijn:

Name	Description
ADGroupUser	De gebruikersdefinitie van de Active Directory-groep.
EmailUser	De definitie van de e-mailgebruiker.
ServicePrincipalUser	De gebruikersdefinitie van de service-principal.

ADGroupUser

De gebruikersdefinitie van de Active Directory-groep.

Name	Vereist	Type	Description
objectId	True	string	De AAD-object-id van de AD-groep.
roles	True	RoleAssignment[]	Lijst met roltoewijzingen waarmee de machtigingen voor toegang tot de toepassing worden opgegeven.
tenantId	True	string	De AAD-tenant-id van de AD-groep.
type	True	string: adGroup	Type gebruiker.

EmailUser

De definitie van de e-mailgebruiker.

Name	Vereist	Type	Description
email	True	string	E-mailadres van de gebruiker.
roles	True	RoleAssignment[]	Lijst met roltoewijzingen waarmee de machtigingen voor toegang tot de toepassing worden opgegeven.
type	True	string: email	Type gebruiker.

ServicePrincipalUser

De gebruikersdefinitie van de service-principal.

Name	Vereist	Type	Description
objectId	True	string	De AAD-object-id van de service-principal.
roles	True	RoleAssignment[]	Lijst met roltoewijzingen waarmee de machtigingen voor toegang tot de toepassing worden opgegeven.
tenantId	True	string	De AAD-tenant-id van de service-principal.
type	True	string: servicePrincipal	Type gebruiker.

Antwoorden

Name	Type	Description
200 OK	User: ADGroupUser EmailUser ServicePrincipalUser	Geslaagd
Other Status Codes	Error	Er is een foutbericht ontvangen van de IoT Central-service. Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

User:

ADGroupUser
EmailUser
ServicePrincipalUser

Geslaagd

Other Status Codes

Error

Er is een foutbericht ontvangen van de IoT Central-service.

Kopteksten

x-ms-error-code: string

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

Add or update a service principal user

Add or update an email user

Add or update a service principal user

Voorbeeldaanvraag

HTTP

PUT https://appsubdomain.azureiotcentral.com/api/users/123?api-version=2022-07-31

{
  "type": "servicePrincipal",
  "tenantId": "027fdad7-cf0f-470a-a26a-272197813322",
  "objectId": "65e13aac-1443-4c49-9d49-57b87197cfff",
  "roles": [
    {
      "role": "c7be2c6b-797e-4551-bb24-33709f6b2e20"
    },
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ]
}

Voorbeeldrespons

Statuscode:: 200

{
  "id": "123",
  "type": "servicePrincipal",
  "tenantId": "027fdad7-cf0f-470a-a26a-272197813322",
  "objectId": "65e13aac-1443-4c49-9d49-57b87197cfff",
  "roles": [
    {
      "role": "c7be2c6b-797e-4551-bb24-33709f6b2e20"
    },
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ]
}

Add or update an email user

Voorbeeldaanvraag

HTTP

PUT https://appsubdomain.azureiotcentral.com/api/users/123?api-version=2022-07-31

{
  "type": "email",
  "roles": [
    {
      "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
    },
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ],
  "email": "bob@contoso.com"
}

Voorbeeldrespons

Statuscode:: 200

{
  "type": "email",
  "roles": [
    {
      "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
    },
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ],
  "email": "bob@contoso.com"
}

Definities

Name	Description
ADGroupUser	De gebruikersdefinitie van de Active Directory-groep.
EmailUser	De definitie van de e-mailgebruiker.
Error	De antwoordfoutdefinitie.
ErrorDetails	De gedetailleerde informatie over de fout.
RoleAssignment	De roltoewijzingsdefinitie.
ServicePrincipalUser	De gebruikersdefinitie van de service-principal.

ADGroupUser

Object

De gebruikersdefinitie van de Active Directory-groep.

Name	Type	Description
id	string	De unieke id van de gebruiker.
objectId	string	De AAD-object-id van de AD-groep.
roles	RoleAssignment[]	Lijst met roltoewijzingen waarmee de machtigingen voor toegang tot de toepassing worden opgegeven.
tenantId	string	De AAD-tenant-id van de AD-groep.
type	string: adGroup	Type gebruiker.

EmailUser

Object

De definitie van de e-mailgebruiker.

Name	Type	Description
email	string	E-mailadres van de gebruiker.
id	string	De unieke id van de gebruiker.
roles	RoleAssignment[]	Lijst met roltoewijzingen waarmee de machtigingen voor toegang tot de toepassing worden opgegeven.
type	string: email	Type gebruiker.

Error

Object

De antwoordfoutdefinitie.

Name	Type	Description
error	ErrorDetails	Foutdetails voor de huidige aanvraag.

ErrorDetails

Object

De gedetailleerde informatie over de fout.

Name	Type	Description
code	string	Foutcode.
message	string	Details van foutbericht.
requestId	string	Correlatie-id voor huidige aanvraag.
time	string (date-time-rfc1123)	Het tijdstip waarop de foutaanvraag is mislukt.

RoleAssignment

Object

De roltoewijzingsdefinitie.

Name	Type	Description
organization	string	Id van de organisatie voor deze roltoewijzing.
role	string	Id van de rol voor deze roltoewijzing.

ServicePrincipalUser

Object

De gebruikersdefinitie van de service-principal.

Name	Type	Description
id	string	De unieke id van de gebruiker.
objectId	string	De AAD-object-id van de service-principal.
roles	RoleAssignment[]	Lijst met roltoewijzingen waarmee de machtigingen voor toegang tot de toepassing worden opgegeven.
tenantId	string	De AAD-tenant-id van de service-principal.
type	string: servicePrincipal	Type gebruiker.