REST Resource: customers.v2.Users

Ressource: User

SCIM-Darstellung eines Nutzers.

JSON-Darstellung 
{
  "schemas": [
    string
  ],
  "emails": [
    {
      object (Email)
    }
  ],
  "addresses": [
    {
      object (Address)
    }
  ],
  "phoneNumbers": [
    {
      object (Phone)
    }
  ],
  "groups": [
    {
      object (GroupReference)
    }
  ],
  "id": string,
  "externalId": string,
  "meta": {
    object (Meta)
  },
  "userName": string,
  "name": {
    object (Name)
  },
  "displayName": string,
  "active": boolean,
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    object (EnterpriseUserExtension)
  }
}
Felder
schemas[]

string

Erforderlich. Eine Liste von URIs, die die Namespaces der SCIM-Schemas angeben, die die Attribute in der aktuellen JSON-Struktur definieren. Darf nur Werte enthalten, die für den User ResourceType als schema und schemaExtensions definiert sind.
emails[]

object (Email)

Optional. Die Liste der E‑Mail-Adressen des Nutzers. Die maximal zulässige Datengröße beträgt 10 KB. Die E‑Mail-Adresse, die userName entspricht, wird dieser Liste automatisch hinzugefügt. Das Unterattribut primary wird auf true festgelegt. Dieser primäre E‑Mail-Eintrag ist schreibgeschützt und kann nicht über dieses Attribut geändert werden.
addresses[]

object (Address)

Optional. Die Liste der physischen Adressen des Nutzers. Die maximal zulässige Datengröße beträgt 10 KB.
phoneNumbers[]

object (Phone)

Optional. Eine Liste der Telefonnummern des Nutzers. Die maximal zulässige Datengröße beträgt 1 KB.
groups[]

object (GroupReference)

Nur Ausgabe. Die Liste der Gruppen, in denen der Nutzer ein direktes Mitglied ist, gekürzt auf maximal 1.000 Gruppen.

Dieses Attribut wird standardmäßig nicht zurückgegeben und muss mit dem Abfrageparameter attributes angefordert werden. Zum Lesen dieses Attributs ist eine Zulassung durch den Kunden erforderlich. Bitte wenden Sie sich an den Support, um Ihren Anwendungsfall zu erläutern und Zugriff zu beantragen.
id

string

ID. Die eindeutige ID für den Nutzer. Die Attributmerkmale sind caseExact als true, eine Unveränderlichkeit von readOnly und ein returned-Merkmal von always.
externalId

string

Optional. Eine vom Client definierte Kennung für den SCIM-Nutzer. Bei diesem Feld wird zwischen Groß- und Kleinschreibung unterschieden und es kann geändert werden. Der Client ist für die Eindeutigkeit verantwortlich, da der Server sie nicht erzwingt.
meta

object (Meta)

Nur Ausgabe. Ein komplexes Attribut, das Ressourcenmetadaten enthält. Alle meta-Unterattribute werden vom Dienstanbieter zugewiesen (haben einen mutability von readOnly) und alle diese Unterattribute haben ein returned-Merkmal von default. Dieses Attribut wird ignoriert, wenn es von Clients bereitgestellt wird.
userName

string

Erforderlich. Die primäre E-Mail-Adresse des Nutzers. Wird als eindeutige Kennung für den Nutzer verwendet.
name

object (Name)

Erforderlich. Der Name des Nutzers.
displayName

string

Optional. Der Anzeigename des Nutzers. Höchstens 256 Zeichen
active

boolean

Optional. Der Kontostatus des Nutzers (false bedeutet, dass das Konto gesperrt ist). Standardeinstellung: true
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

object (EnterpriseUserExtension)

Optional. SCIM-Erweiterungsattribute für Unternehmensnutzer.

Name

SCIM-Darstellung des Namens eines Nutzers.

JSON-Darstellung 
{
  "familyName": string,
  "givenName": string
}
Felder
familyName

string

Erforderlich. Der Nachname des Nutzers.
givenName

string

Erforderlich. Der Vorname des Nutzers.

E-Mail

SCIM-Darstellung der E-Mail-Adresse eines Nutzers.

JSON-Darstellung 
{
  "value": string,
  "type": string,
  "primary": boolean
}
Felder
value

string

Erforderlich. Die E-Mail-Adresse des Nutzers.
type

string

Der Typ des E-Mail-Kontos. Gültige Werte sind home, work und other.
primary

boolean

Nur Ausgabe. Gibt an, ob es sich um die primäre E-Mail-Adresse des Nutzers handelt. Dieser Wert wird nur für die E-Mail-Adresse, die userName entspricht, auf true festgelegt.

Adresse

SCIM-Darstellung der Adresse eines Nutzers.

JSON-Darstellung 
{
  "formatted": string,
  "streetAddress": string,
  "locality": string,
  "region": string,
  "postalCode": string,
  "country": string,
  "type": string,
  "primary": boolean
}
Felder
formatted

string

Vollständige Adresse, für die Anzeige formatiert.
streetAddress

string

Die Adresse.
locality

string

Die Stadt oder der Ort.
region

string

Die Region oder der Bundesstaat.
postalCode

string

Die Postleitzahl.
country

string

Das Land.
type

string

Der Typ der Adresse. Gültige Werte sind home, work und other.
primary

boolean

Gibt an, ob es sich um die primäre Adresse des Nutzers handelt.

Telefon

SCIM-Darstellung der Telefonnummer eines Nutzers.

JSON-Darstellung 
{
  "value": string,
  "type": string,
  "primary": boolean
}
Felder
value

string

Erforderlich. Die Telefonnummer.
type

string

Der Typ der Telefonnummer. Gültige Werte sind home, work, mobile, fax, pager und other.
primary

boolean

Gibt an, ob dies die primäre Telefonnummer des Nutzers ist.

EnterpriseUserExtension

Definiert die Attribute für die SCIM Enterprise User-Erweiterung. Der Schema-URN für diese Erweiterung lautet: urn:ietf:params:scim:schemas:extension:enterprise:2.0:User. Weitere Informationen finden Sie unter RFC 7643, Abschnitt 4.3.

JSON-Darstellung 
{
  "employeeNumber": string,
  "costCenter": string,
  "organization": string,
  "department": string
}
Felder
employeeNumber

string

Optional. Kennung, die in der Regel von der Organisation zugewiesen wird und mit der der Nutzer innerhalb der Organisation identifiziert wird.
costCenter

string

Optional. Kennung für die Kostenstelle, der die Ausgaben des Nutzers zugeordnet werden.
organization

string

Optional. Der Name einer Organisation, zu der ein Nutzer gehört.
department

string

Optional. Der Name der Abteilung, zu der ein Nutzer gehört, im Textformat.

GroupReference

SCIM-Darstellung der Gruppenmitgliedschaft eines Nutzers.

JSON-Darstellung 
{
  "value": string,
  "$ref": string,
  "type": string
}
Felder
value

string

Nur Ausgabe. Die id der SCIM-Ressource, die die Gruppe darstellt.
$ref

string

Nur Ausgabe. Der URI der SCIM-Ressource, die die Gruppe darstellt.
type

string

Nur Ausgabe. Der Typ der Gruppenmitgliedschaft. Gültige Werte sind direct und indirect.

Methoden

create

 Erstellt einen Nutzer.

delete

 Löscht einen Nutzer.

get

 Ruft einen Nutzer ab.

list

 Ruft eine Liste von Nutzern ab.

patch

 Aktualisiert einen Nutzer mit SCIM-Patch-Semantik.