REST Resource: customers.v2.ServiceProviderConfig

Ressource: ServiceProviderConfig

Aus RFC 7643, Abschnitt 5. Die Konfigurationsressource für Dienstanbieter ermöglicht es einem Dienstanbieter, SCIM-Spezifikationsfunktionen in standardisierter Form zu ermitteln und Clients zusätzliche Implementierungsdetails bereitzustellen.

JSON-Darstellung 
{
  "schemas": [
    string
  ],
  "authenticationSchemes": [
    {
      object (AuthenticationScheme)
    }
  ],
  "documentationUri": string,
  "patch": {
    object (PatchFeature)
  },
  "bulk": {
    object (BulkFeature)
  },
  "filter": {
    object (FilterFeature)
  },
  "changePassword": {
    object (ChangePasswordFeature)
  },
  "sort": {
    object (SortFeature)
  },
  "etag": {
    object (EtagFeature)
  },
  "meta": {
    object (Meta)
  }
}
Felder
schemas[]

string

Nur Ausgabe. Das Attribut schemas enthält URIs, die zum Angeben der Namespaces der SCIM-Schemas verwendet werden, die die Attribute in der aktuellen JSON-Struktur definieren.
authenticationSchemes[]

object (AuthenticationScheme)

Nur Ausgabe. Ein komplexer Typ mit mehreren Werten, der die unterstützten Authentifizierungsschemas angibt.
documentationUri

string

Nur Ausgabe. Eine HTTP-adressierbare URL, die auf die für Menschen lesbare Hilfedokumentation des Dienstanbieters verweist.
patch

object (PatchFeature)

Nur Ausgabe. Ein komplexer Typ, der die Unterstützung von PATCH-Funktionen angibt.
bulk

object (BulkFeature)

Nur Ausgabe. Ein komplexer Typ, der die Unterstützung von Bulk-Vorgängen angibt.
filter

object (FilterFeature)

Nur Ausgabe. Ein komplexer Typ, der die Filterunterstützung angibt.
changePassword

object (ChangePasswordFeature)

Nur Ausgabe. Ein komplexer Typ, der die Unterstützung für die Passwortänderung angibt.
sort

object (SortFeature)

Nur Ausgabe. Ein komplexer Typ, der die Sortierunterstützung angibt.
etag

object (EtagFeature)

Nur Ausgabe. Ein komplexer Typ, der die ETag-Unterstützung angibt.
meta

object (Meta)

Nur Ausgabe. Vom Dienstanbieter zugewiesene Ressourcenmetadaten.

PatchFeature

Ein komplexer Typ, der die Unterstützung von PATCH-Funktionen angibt.

JSON-Darstellung 
{
  "supported": boolean
}
Felder
supported

boolean

Nur Ausgabe. Gibt an, ob der Vorgang unterstützt wird.

BulkFeature

Ein komplexer Typ, der die Unterstützung von Bulk-Vorgängen angibt.

JSON-Darstellung 
{
  "supported": boolean,
  "maxOperations": integer,
  "maxPayloadSize": integer
}
Felder
supported

boolean

Nur Ausgabe. Gibt an, ob der Vorgang unterstützt wird.
maxOperations

integer

Nur Ausgabe. Gibt die maximale Anzahl von Vorgängen an.
maxPayloadSize

integer

Nur Ausgabe. Gibt die maximale Nutzlastgröße in Byte an.

FilterFeature

Ein komplexer Typ, der die Filterunterstützung angibt.

JSON-Darstellung 
{
  "supported": boolean,
  "maxResults": integer
}
Felder
supported

boolean

Nur Ausgabe. Gibt an, ob der Vorgang unterstützt wird.
maxResults

integer

Nur Ausgabe. Gibt die maximale Anzahl von Ergebnissen an.

ChangePasswordFeature

Ein komplexer Typ, der die Unterstützung für die Passwortänderung angibt.

JSON-Darstellung 
{
  "supported": boolean
}
Felder
supported

boolean

Nur Ausgabe. Gibt an, ob der Vorgang unterstützt wird.

SortFeature

Ein komplexer Typ, der die Sortierunterstützung angibt.

JSON-Darstellung 
{
  "supported": boolean
}
Felder
supported

boolean

Nur Ausgabe. Gibt an, ob der Vorgang unterstützt wird.

EtagFeature

Ein komplexer Typ, der die ETag-Unterstützung angibt.

JSON-Darstellung 
{
  "supported": boolean
}
Felder
supported

boolean

Nur Ausgabe. Gibt an, ob der Vorgang unterstützt wird.

AuthenticationScheme

Ein komplexer Typ mit mehreren Werten, der die unterstützten Authentifizierungsschemas angibt.

JSON-Darstellung 
{
  "type": string,
  "name": string,
  "description": string,
  "specUri": string,
  "documentationUri": string,
  "primary": boolean
}
Felder
type

string

Nur Ausgabe. Der Authentifizierungsschematyp.
name

string

Nur Ausgabe. Der Name des Authentifizierungsschemas.
description

string

Nur Ausgabe. Eine Beschreibung des Authentifizierungsschemas.
specUri

string

Nur Ausgabe. Eine HTTP-adressierbare URL, die auf die Spezifikation des Authentifizierungsschemas verweist.
documentationUri

string

Nur Ausgabe. Eine HTTP-adressierbare URL, die auf die Dokumentation des Authentifizierungsschemas verweist.
primary

boolean

Nur Ausgabe. Gibt das primary- oder bevorzugte Authentifizierungsschema an.

Methoden

get

 Ruft die Konfiguration des Dienstanbieters ab.