REST Resource: customers.v2.Users

Resource: User

Representasi SCIM pengguna.

Representasi JSON 
{
  "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)
  }
}
Kolom
schemas[]

string

Wajib. Daftar URI yang menunjukkan namespace skema SCIM yang menentukan atribut yang ada dalam struktur JSON saat ini. Hanya boleh berisi nilai yang ditentukan sebagai schema dan schemaExtensions untuk User ResourceType.
emails[]

object (Email)

Opsional. Daftar alamat email pengguna. Ukuran data maksimum yang diizinkan adalah 10 KB. Email yang sesuai dengan userName akan otomatis ditambahkan ke daftar ini dengan sub-atribut primary yang ditetapkan ke true. Entri email utama ini bersifat hanya baca dan tidak dapat diubah melalui atribut ini.
addresses[]

object (Address)

Opsional. Daftar alamat fisik pengguna. Ukuran data maksimum yang diizinkan adalah 10 KB.
phoneNumbers[]

object (Phone)

Opsional. Daftar nomor telepon pengguna. Ukuran data maksimum yang diizinkan adalah 1 KB.
groups[]

object (GroupReference)

Hanya output. Daftar grup tempat pengguna memiliki keanggotaan langsung, yang dipangkas hingga maksimum 1.000 grup.

Atribut ini tidak ditampilkan secara default dan harus diminta menggunakan parameter kueri attributes. Membaca atribut ini memerlukan izin dari pelanggan. Hubungi tim dukungan untuk menjelaskan kasus penggunaan Anda dan meminta akses.
id

string

ID. ID unik untuk pengguna. Karakteristik atribut adalah caseExact sebagai true, kemampuan berubah readOnly, dan karakteristik returned dari always.
externalId

string

Opsional. ID yang ditentukan klien untuk pengguna SCIM. Kolom ini peka huruf besar/kecil dan dapat diubah. Klien bertanggung jawab untuk memastikan keunikan, karena server tidak menerapkannya.
meta

object (Meta)

Hanya output. Atribut kompleks yang berisi metadata resource. Semua sub-atribut meta ditetapkan oleh penyedia layanan (memiliki mutability readOnly), dan semua sub-atribut ini memiliki karakteristik returned default. Atribut ini diabaikan saat disediakan oleh klien.
userName

string

Wajib. Alamat email utama pengguna. Digunakan sebagai ID unik untuk pengguna.
name

object (Name)

Wajib. Nama pengguna.
displayName

string

Opsional. Nama tampilan pengguna. Batas: 256 karakter.
active

boolean

Opsional. Status akun pengguna (false berarti akun ditangguhkan). Default: true.
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

object (EnterpriseUserExtension)

Opsional. Atribut ekstensi Pengguna Enterprise SCIM.

Nama

Representasi SCIM dari nama Pengguna.

Representasi JSON 
{
  "familyName": string,
  "givenName": string
}
Kolom
familyName

string

Wajib. Nama keluarga pengguna.
givenName

string

Wajib. Nama depan pengguna.

Email

Representasi SCIM dari email pengguna.

Representasi JSON 
{
  "value": string,
  "type": string,
  "primary": boolean
}
Kolom
value

string

Wajib. Alamat email pengguna.
type

string

Jenis akun email. Nilai yang valid adalah home, work, dan other.
primary

boolean

Hanya output. Menunjukkan apakah ini adalah email utama pengguna. Nilai ini disetel ke true hanya untuk email yang sesuai dengan userName.

Alamat

Representasi SCIM dari alamat pengguna.

Representasi JSON 
{
  "formatted": string,
  "streetAddress": string,
  "locality": string,
  "region": string,
  "postalCode": string,
  "country": string,
  "type": string,
  "primary": boolean
}
Kolom
formatted

string

Alamat lengkap, diformat untuk ditampilkan.
streetAddress

string

Alamat.
locality

string

Kota atau lokalitas.
region

string

Wilayah atau negara bagian.
postalCode

string

Kode pos.
country

string

Negara.
type

string

Jenis alamat. Nilai yang valid adalah home, work, dan other.
primary

boolean

Menunjukkan apakah ini alamat utama pengguna.

Telepon

Representasi SCIM dari nomor telepon pengguna.

Representasi JSON 
{
  "value": string,
  "type": string,
  "primary": boolean
}
Kolom
value

string

Wajib. Nomor telepon.
type

string

Jenis nomor telepon. Nilai yang valid adalah home, work, mobile, fax, pager, dan other.
primary

boolean

Menunjukkan apakah ini adalah nomor telepon utama pengguna.

EnterpriseUserExtension

Menentukan atribut untuk ekstensi Pengguna Perusahaan SCIM. URN skema untuk ekstensi ini adalah: urn:ietf:params:scim:schemas:extension:enterprise:2.0:User. Lihat RFC 7643 Bagian 4.3 untuk mengetahui detail selengkapnya.

Representasi JSON 
{
  "employeeNumber": string,
  "costCenter": string,
  "organization": string,
  "department": string
}
Kolom
employeeNumber

string

Opsional. ID, biasanya ditetapkan oleh organisasi, yang digunakan untuk mengidentifikasi pengguna di dalam organisasi.
costCenter

string

Opsional. ID untuk pusat biaya yang menjadi tujuan atribusi pengeluaran pengguna.
organization

string

Opsional. Nama organisasi tempat pengguna berada.
department

string

Opsional. Nama departemen tempat pengguna berada dalam format teks.

GroupReference

Representasi SCIM keanggotaan grup pengguna.

Representasi JSON 
{
  "value": string,
  "$ref": string,
  "type": string
}
Kolom
value

string

Hanya output. id dari resource SCIM yang merepresentasikan grup.
$ref

string

Hanya output. URI resource SCIM yang merepresentasikan grup.
type

string

Hanya output. Jenis keanggotaan grup. Nilai yang valid adalah direct dan indirect.

Metode

create

 Membuat Pengguna.

delete

 Menghapus Pengguna.

get

 Mengambil Pengguna.

list

 Mengambil daftar Pengguna.

patch

 Memperbarui Pengguna menggunakan semantik patch SCIM.