Dela via

Users - Create

Tjänst:
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

maxLength: 48
pattern: ^[a-zA-Z0-9-_]*$

Unikt ID för användaren.
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

Användardefinitionen för e-post.
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

AD-gruppens AAD-klientorganisations-ID.
type True string:

adGroup

Typ av användare.

EmailUser

Användardefinitionen för e-post.

Name Obligatorisk Typ Description
email True

string

E-postadress till användaren.
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-klient-ID för tjänstens huvudnamn.
type True string:

servicePrincipal

Typ av användare.

Svar

Name Typ Description
200 OK User:

Framgång
Other Status Codes

Error

Ett felsvar som togs emot från IoT Central-tjänsten.

Sidhuvuden

x-ms-error-code: string

Säkerhet

azure_auth

Azure Active Directory OAuth2-flöde

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

Exempelbegäran

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

Exempelsvar

Statuskod:
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

Exempelbegäran

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

Exempelsvar

Statuskod:
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

Användardefinitionen för e-post.
Error

Svarsfeldefinitionen.
ErrorDetails

Information om felet.
RoleAssignment

Rolltilldelningsdefinitionen.
ServicePrincipalUser

Användardefinitionen för tjänstens huvudnamn.

ADGroupUser

Objekt

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

AD-gruppens AAD-klientorganisations-ID.
type string:

adGroup

Typ av användare.

EmailUser

Objekt

Användardefinitionen för e-post.

Name Typ Description
email

string

E-postadress till användaren.
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

Objekt

Svarsfeldefinitionen.

Name Typ Description
error

ErrorDetails

Felinformation för aktuell begäran.

ErrorDetails

Objekt

Information om felet.

Name Typ Description
code

string

Felkod.
message

string

Information om felmeddelande.
requestId

string

Korrelations-ID för aktuell begäran.
time

string (date-time-rfc1123)

Den tid då felbegäran misslyckades.

RoleAssignment

Objekt

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

Objekt

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-klient-ID för tjänstens huvudnamn.
type string:

servicePrincipal

Typ av användare.