REST-Ressource: accounts.customers.entitlements

Ressource: Berechtigung

Eine Berechtigung stellt eine Entität dar, mit der ein Reseller mit der Nutzung eines Dienstes starten kann. Berechtigungen sind schreibgeschützt und werden im Rahmen der Bestellabwicklung aktualisiert.

JSON-Darstellung 

{
  "name": string,
  "orderId": string,
  "state": enum(State),
  "stateReason": string,
  "createTime": string,
  "updateTime": string,
  "channelPartnerId": string
}
Felder
name

string

Ressourcenname einer Berechtigung im Format accounts/{account_id}/customers/{customer_id}/entitlements/{id}.

orderId

string

Bestell-ID, die zur Erstellung dieser Berechtigung geführt hat.

state

enum(State)

Status der Berechtigung.

stateReason

string

Erläuterung des Status der Berechtigung.

createTime

string (Timestamp format)

Schreibgeschützt. Der Zeitpunkt, zu dem die Berechtigung erstellt wird.

Ein Zeitstempel im Format "RFC3339 UTC 'Zulu'" in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Der Zeitpunkt, zu dem die Berechtigung aktualisiert wird.

Ein Zeitstempel im Format "RFC3339 UTC 'Zulu'" in Nanosekunden. Beispiel: "2014-10-02T15:01:23.045123456Z".
channelPartnerId

string

Cloud Identity-ID des Kanalpartners, der der direkte Reseller für die Bestellung des Kunden ist. Dieses Feld wird im Allgemeinen bei 2-stufigen Bestellungen verwendet, wenn die Bestellung von einem Top-Level-Händler im Auftrag seines Kanalpartners oder Resellers aufgegeben wird.

Status

Zeigt den aktuellen Status der Berechtigung an.

Enums
STATE_UNSPECIFIED Standardwert. Dieser Wert sollte nie zurückgegeben werden.
ERROR Beim Erstellen oder Aktivieren der Berechtigung ist ein Fehler aufgetreten.
ACTIVE Die Berechtigung ist derzeit aktiv.
COMPLETE Die Berechtigung ist abgelaufen und wurde nicht verlängert oder storniert. Wenn für eine Berechtigung COMPLETE gilt, ändert sich ihr Status nicht mehr.
CANCELED Die Berechtigung wurde nicht erfüllt. Wenn für eine Berechtigung CANCELED gilt, ändert sich ihr Status nicht mehr.
PENDING Die Berechtigung wurde erstellt, aber nicht bereitgestellt. Die Berechtigung kann diesen Status haben, wenn die Annahme der Nutzungsbedingungen aussteht.
SUSPENDED Die Berechtigung ist derzeit gesperrt.

Methoden

assignChannelPartner

 Weist einer Entitlement-Ressource einen Kanalpartner zu.

get

 Gibt eine angeforderte Entitlement-Ressource zurück.

list

 Listet die Entitlement-Ressourcen eines Kunden auf.