REST Resource: customers.v2.Schemas

Resource: Schema

Dari RFC 7643 Bagian 7. Menentukan metadata tentang skema.

Representasi JSON
{
  "attributes": [
    {
      object (Attribute)
    }
  ],
  "id": string,
  "name": string,
  "description": string
}
Kolom
attributes[]

object (Attribute)

Wajib. Daftar atribut skema.

id

string

Wajib. URI unik skema. Jika berlaku, penyedia layanan harus menentukan URI, misalnya, urn:ietf:params:scim:schemas:core:2.0:User. Tidak seperti sebagian besar skema lainnya, yang menggunakan semacam Globally Unique Identifier (GUID) untuk id, skema id adalah URI sehingga dapat didaftarkan dan portabel di antara berbagai penyedia layanan dan klien.

name

string

Opsional. Nama skema yang dapat dibaca manusia. Jika berlaku, penyedia layanan harus menentukan nama, misalnya, User atau Group.

description

string

Opsional. Deskripsi skema yang dapat dibaca manusia. Jika berlaku, penyedia layanan harus menentukan deskripsi.

Atribut

Dari RFC 7643 Bagian 7. Mendefinisikan karakteristik atribut.

Representasi JSON
{
  "subAttributes": [
    {
      object (Attribute)
    }
  ],
  "canonicalValues": [
    string
  ],
  "referenceTypes": [
    string
  ],
  "name": string,
  "type": string,
  "multiValued": boolean,
  "description": string,
  "required": boolean,
  "caseExact": boolean,
  "mutability": string,
  "returned": string,
  "uniqueness": string
}
Kolom
subAttributes[]

object (Attribute)

Jika atribut bertipe complex, subAttributes menentukan sekumpulan sub-atribut. subAttributes memiliki sub-atribut skema yang sama dengan attributes.

canonicalValues[]

string

Opsional. Kumpulan nilai kanonis yang disarankan yang dapat digunakan (misalnya, work dan home). Dalam beberapa kasus, penyedia layanan dapat memilih untuk mengabaikan nilai yang tidak didukung.

referenceTypes[]

string

Array multi-nilai dari string JSON yang menunjukkan jenis resource SCIM yang dapat dirujuk. Nilai yang valid adalah sebagai berikut:

  • Jenis resource SCIM (misalnya, User atau Group),
  • external - menunjukkan bahwa resource adalah resource eksternal (misalnya, foto), atau
  • uri - menunjukkan bahwa referensi adalah ke endpoint layanan atau ID (misalnya, URN skema).

Atribut ini hanya berlaku untuk atribut yang berjenis reference (Bagian 2.3.7).

name

string

Nama atribut.

type

string

Jenis data atribut. Nilai yang valid adalah string, boolean, decimal, integer, dateTime, reference, dan complex. Jika atribut bertipe complex, harus ada atribut skema subAttributes yang sesuai dan ditentukan, yang mencantumkan sub-atribut dari atribut tersebut.

multiValued

boolean

Menunjukkan bentuk jamak atribut.

description

string

Deskripsi atribut yang dapat dibaca manusia. Jika berlaku, penyedia layanan harus menentukan deskripsi.

required

boolean

Menentukan apakah atribut diperlukan atau tidak.

caseExact

boolean

Menentukan apakah atribut string peka huruf besar/kecil atau tidak. Server menggunakan sensitivitas huruf besar/kecil saat mengevaluasi filter. Untuk atribut yang peka huruf besar/kecil, server mempertahankan huruf besar/kecil untuk setiap nilai yang dikirimkan. Jika atribut tidak peka huruf besar/kecil, server dapat mengubah huruf besar/kecil untuk nilai yang dikirimkan. Sensitivitas huruf besar/kecil juga memengaruhi cara nilai atribut dibandingkan dengan nilai filter (lihat RFC 7644 Bagian 3.4.2.2).

Sesuai dengan RFC 7643 Bagian 2.3.6 dan RFC 7643 Bagian 2.3.7, jenis binary dan reference adalah caseExact.

mutability

string

Satu kata kunci yang menunjukkan keadaan saat nilai atribut dapat (di)definisikan ulang:

  • readOnly: Atribut tidak dapat diubah.
  • readWrite: Default. Atribut dapat diperbarui dan dibaca kapan saja.
  • immutable: Atribut dapat ditentukan saat pembuatan resource (misalnya, POST) atau saat penggantian data melalui permintaan (misalnya, PUT). Atribut tidak dapat diubah setelah definisi awal.
  • writeOnly: Atribut dapat diperbarui kapan saja. Nilai atribut tidak ditampilkan (misalnya, karena nilai adalah hash yang disimpan). Catatan: Atribut dengan kemampuan berubah writeOnly biasanya juga memiliki setelan yang ditampilkan never.
returned

string

Satu kata kunci yang menunjukkan kapan atribut dan nilai terkait ditampilkan sebagai respons terhadap permintaan GET atau sebagai respons terhadap permintaan PUT, POST, atau PATCH. Kata kunci yang valid adalah sebagai berikut:

  • always: Atribut ini selalu ditampilkan, terlepas dari konten parameter attributes. Misalnya, id selalu ditampilkan untuk mengidentifikasi resource SCIM.
  • never: Atribut tidak pernah ditampilkan. Hal ini dapat terjadi karena nilai atribut asli (misalnya, nilai yang di-hash) tidak dipertahankan oleh penyedia layanan. Penyedia layanan dapat mengizinkan atribut digunakan dalam filter penelusuran.
  • default: Default. Atribut ini ditampilkan secara default dalam semua respons operasi SCIM yang menampilkan nilai atribut. Jika parameter attributes permintaan GET ditentukan, nilai atribut hanya ditampilkan jika atribut diberi nama dalam parameter attributes.
  • request: Atribut ditampilkan sebagai respons terhadap operasi PUT, POST, atau PATCH jika atribut ditentukan oleh klien (misalnya, atribut diubah). Atribut ditampilkan dalam operasi kueri SCIM hanya jika ditentukan dalam parameter attributes.
uniqueness

string

Nilai kata kunci tunggal yang menentukan cara penyedia layanan menerapkan keunikan nilai atribut. Server dapat menolak nilai yang tidak valid berdasarkan keunikan dengan menampilkan kode respons HTTP 400 Bad Request. Klien dapat menerapkan keunikan di sisi klien dengan tingkat yang lebih tinggi daripada yang diterapkan oleh penyedia layanan. Misalnya, klien dapat membuat nilai unik sementara server memiliki keunikan none. Kata kunci yang valid adalah sebagai berikut:

  • none: Default. Nilai tidak dimaksudkan untuk menjadi unik dengan cara apa pun.
  • server: Nilai harus unik dalam konteks endpoint SCIM (atau tenancy) saat ini dan mungkin unik secara global (misalnya, nama pengguna, alamat email, atau kunci atau penghitung yang dihasilkan server lainnya). Tidak boleh ada dua resource di server yang sama yang memiliki nilai yang sama.
  • global: Nilai harus unik secara global (misalnya, alamat email, GUID, atau nilai lainnya). Tidak ada dua resource di server mana pun yang boleh memiliki nilai yang sama.

Seperti yang ditentukan dalam RFC 7643 Bagian 2.3, jenis data Boolean, DateTime, Binary, dan Complex tidak memiliki keunikan.

Metode

get

Mengambil Skema.

list

Mengambil semua Skema.