Users - Create

Service:

IoT Central

API Version:

2022-07-31

Skapa en användare i programmet

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
baseDomain	path	True	string	Basdomänen för alla Azure IoT Central-tjänstbegäranden.
subdomain	path	True	string	Programmets underdomän.
userId	path	True	string	Unikt ID för användaren. Regex pattern: ^[a-zA-Z0-9-_]*$
api-version	query	True	string	Den version av API:et som anropas.

Begärandetext

Brödtexten i begäran kan vara något av följande:

Name	Description
ADGroupUser	Användardefinitionen för active directory-gruppen.
EmailUser	E-postanvändardefinitionen.
ServicePrincipalUser	Användardefinitionen för tjänstens huvudnamn.

ADGroupUser

Användardefinitionen för active directory-gruppen.

Name	Obligatorisk	Typ	Description
objectId	True	string	AAD-objekt-ID för AD-gruppen.
roles	True	RoleAssignment[]	Lista över rolltilldelningar som anger behörigheter för att komma åt programmet.
tenantId	True	string	AAD-klientorganisations-ID för AD-gruppen.
type	True	string: adGroup	Typ av användare.

EmailUser

E-postanvändardefinitionen.

Name	Obligatorisk	Typ	Description
email	True	string	Användarens e-postadress.
roles	True	RoleAssignment[]	Lista över rolltilldelningar som anger behörigheter för att komma åt programmet.
type	True	string: email	Typ av användare.

ServicePrincipalUser

Användardefinitionen för tjänstens huvudnamn.

Name	Obligatorisk	Typ	Description
objectId	True	string	AAD-objekt-ID för tjänstens huvudnamn.
roles	True	RoleAssignment[]	Lista över rolltilldelningar som anger behörigheter för att komma åt programmet.
tenantId	True	string	AAD-klientorganisations-ID för tjänstens huvudnamn.
type	True	string: servicePrincipal	Typ av användare.

Svar

Name	Typ	Description
200 OK	User: ADGroupUser EmailUser ServicePrincipalUser	Klart
Other Status Codes	Error	Ett felsvar som tagits emot från IoT Central-tjänsten. Headers x-ms-error-code: string

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

Add or update a service principal user

Add or update an email user

Add or update a service principal user

Sample Request

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

Sample Response

Status code:

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

Sample Request

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

Sample Response

Status code:

200

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

Definitioner

Name	Description
ADGroupUser	Användardefinitionen för active directory-gruppen.
EmailUser	E-postanvändardefinitionen.
Error	Definitionen av svarsfel.
ErrorDetails	Detaljerad information om felet.
RoleAssignment	Rolltilldelningsdefinitionen.
ServicePrincipalUser	Användardefinitionen för tjänstens huvudnamn.

ADGroupUser

Användardefinitionen för active directory-gruppen.

Name	Typ	Description
id	string	Unikt ID för användaren.
objectId	string	AAD-objekt-ID för AD-gruppen.
roles	RoleAssignment[]	Lista över rolltilldelningar som anger behörigheter för att komma åt programmet.
tenantId	string	AAD-klientorganisations-ID för AD-gruppen.
type	string: adGroup	Typ av användare.

EmailUser

E-postanvändardefinitionen.

Name	Typ	Description
email	string	Användarens e-postadress.
id	string	Unikt ID för användaren.
roles	RoleAssignment[]	Lista över rolltilldelningar som anger behörigheter för att komma åt programmet.
type	string: email	Typ av användare.

Error

Definitionen av svarsfel.

Name	Typ	Description
error	ErrorDetails	Felinformation för aktuell begäran.

ErrorDetails

Detaljerad information om felet.

Name	Typ	Description
code	string	Felkod.
message	string	Information om felmeddelanden.
requestId	string	Korrelations-ID för aktuell begäran.
time	string	Den tid då felbegäran misslyckades.

RoleAssignment

Rolltilldelningsdefinitionen.

Name	Typ	Description
organization	string	ID för organisationen för den här rolltilldelningen.
role	string	ID för rollen för den här rolltilldelningen.

ServicePrincipalUser

Användardefinitionen för tjänstens huvudnamn.

Name	Typ	Description
id	string	Unikt ID för användaren.
objectId	string	AAD-objekt-ID för tjänstens huvudnamn.
roles	RoleAssignment[]	Lista över rolltilldelningar som anger behörigheter för att komma åt programmet.
tenantId	string	AAD-klientorganisations-ID för tjänstens huvudnamn.
type	string: servicePrincipal	Typ av användare.