REST Resource: customers.v2.ServiceProviderConfig

משאב: ServiceProviderConfig

מתוך RFC 7643 section 5. משאב ההגדרה של ספק השירותים מאפשר לספק השירותים לגלות תכונות של מפרט SCIM בצורה סטנדרטית, וגם לספק ללקוחות פרטים נוספים על ההטמעה.

ייצוג JSON
{
  "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)
  }
}
שדות
schemas[]

string

פלט בלבד. המאפיין schemas מכיל כתובות URI שמשמשות לציון מרחבי השמות של סכימות SCIM שמגדירות את המאפיינים שמופיעים במבנה ה-JSON הנוכחי.

authenticationSchemes[]

object (AuthenticationScheme)

פלט בלבד. סוג מורכב עם כמה ערכים שמציין את סכימות האימות הנתמכות.

documentationUri

string

פלט בלבד. כתובת URL שאפשר לגשת אליה דרך HTTP, שמובילה למסמכי העזרה של ספק השירות שנועדו לקריאה על ידי בני אדם.

patch

object (PatchFeature)

פלט בלבד. סוג מורכב שמציין תמיכה בתכונת PATCH.

bulk

object (BulkFeature)

פלט בלבד. סוג מורכב שמציין תמיכה בפעולות בכמות גדולה.

filter

object (FilterFeature)

פלט בלבד. סוג מורכב שמציין תמיכה במסנן.

changePassword

object (ChangePasswordFeature)

פלט בלבד. סוג מורכב שמציין תמיכה בשינוי סיסמה.

sort

object (SortFeature)

פלט בלבד. סוג מורכב שמציין תמיכה במיון.

etag

object (EtagFeature)

פלט בלבד. סוג מורכב שמציין תמיכה ב-ETag.

meta

object (Meta)

פלט בלבד. מטא-נתונים של משאבים שהוקצו על ידי ספק השירות.

PatchFeature

סוג מורכב שמציין תמיכה בתכונת PATCH.

ייצוג JSON
{
  "supported": boolean
}
שדות
supported

boolean

פלט בלבד. המדיניות הזו קובעת אם הפעולה נתמכת או לא.

BulkFeature

סוג מורכב שמציין תמיכה בפעולות בכמות גדולה.

ייצוג JSON
{
  "supported": boolean,
  "maxOperations": integer,
  "maxPayloadSize": integer
}
שדות
supported

boolean

פלט בלבד. המדיניות הזו קובעת אם הפעולה נתמכת או לא.

maxOperations

integer

פלט בלבד. מציין את המספר המקסימלי של פעולות.

maxPayloadSize

integer

פלט בלבד. מציין את הגודל המקסימלי של מטען הייעודי (payload) בבייטים.

FilterFeature

סוג מורכב שמציין תמיכה במסנן.

ייצוג JSON
{
  "supported": boolean,
  "maxResults": integer
}
שדות
supported

boolean

פלט בלבד. המדיניות הזו קובעת אם הפעולה נתמכת או לא.

maxResults

integer

פלט בלבד. מציין את המספר המקסימלי של תוצאות.

ChangePasswordFeature

סוג מורכב שמציין תמיכה בשינוי סיסמה.

ייצוג JSON
{
  "supported": boolean
}
שדות
supported

boolean

פלט בלבד. המדיניות הזו קובעת אם הפעולה נתמכת או לא.

SortFeature

סוג מורכב שמציין תמיכה במיון.

ייצוג JSON
{
  "supported": boolean
}
שדות
supported

boolean

פלט בלבד. המדיניות הזו קובעת אם הפעולה נתמכת או לא.

EtagFeature

סוג מורכב שמציין תמיכה ב-ETag.

ייצוג JSON
{
  "supported": boolean
}
שדות
supported

boolean

פלט בלבד. המדיניות הזו קובעת אם הפעולה נתמכת או לא.

AuthenticationScheme

סוג מורכב עם כמה ערכים שמציין את סכימות האימות הנתמכות.

ייצוג JSON
{
  "type": string,
  "name": string,
  "description": string,
  "specUri": string,
  "documentationUri": string,
  "primary": boolean
}
שדות
type

string

פלט בלבד. סוג סכימת האימות.

name

string

פלט בלבד. השם של סכימת האימות.

description

string

פלט בלבד. תיאור של סכימת האימות.

specUri

string

פלט בלבד. כתובת URL שאפשר לגשת אליה דרך HTTP ומפנה למפרט של סכמת האימות.

documentationUri

string

פלט בלבד. כתובת URL שאפשר לגשת אליה דרך HTTP, שמפנה למסמכי התיעוד של סכמת האימות.

primary

boolean

פלט בלבד. מציין את primary או את סכימת האימות המועדפת.

Methods

get

מאחזר את ההגדרה של ספק השירות.