Directory API: Kuruluş Birimleri

Kuruluş birimlerini yönetme

Bir Google Workspace hesabının kuruluş ağacı, kullanıcılarınızı mantıksal ve hiyerarşik bir yapı içinde yönetmenizi sağlayan kuruluş birimlerinden oluşur. Bu işlev, Yönetici Konsolu'ndaki "Kuruluşlar ve kullanıcılar" bölümünde bulunan işlevlere benzer. sekmesinden yararlanın. Müşterinin kuruluş birimi hiyerarşisi 35 derinlik düzeyiyle sınırlıdır. Daha fazla bilgi edinmek için Yönetici Yardım Merkezi'ne göz atın.

  • Bir Google Workspace hesabının yalnızca bir kuruluş ağacı vardır. Bu hesap ilk yapılandırıldığında hesap düzeyinde bir kuruluş birimi olur. Bu, birincil alanla ilişkilendirilen kuruluştur. Birincil alanla ilgili daha fazla bilgi edinmek için API sınırlarıyla ilgili bilgilere bakın.
  • Bir kuruluş biriminin yol adı benzersizdir. Kuruluş biriminin adı, kuruluş hiyerarşisinde benzersiz olmayabilir ancak kuruluş biriminin adı, kardeş kuruluş birimleri arasında benzersizdir. Ayrıca, kuruluş biriminin adı büyük/küçük harfe duyarlı değildir.
  • Bir kuruluş birimi, kuruluş hiyerarşisindeki politikaları devralır. Herhangi bir kuruluş birimi, devralınan politikayı geçersiz kılarak bu ebeveyn devralma zincirini engelleyebilir. İlgili içeriği oluşturmak için kullanılan bir politikanın diğerine göre önceliği en yakın kuruluş birimi tarafından belirlenir. Diğer bir deyişle, bir alt kuruluş biriminin politikaları, ebeveyn birimi sayısında artış oldu. blockInheritance ayarı, bir kuruluş birimine ve onun alt kuruluşuna ulaşabilirsiniz. blockInheritance desteği sonlandırıldı. Politikanın "true" (doğru) değerine ayarlanması artık desteklenmemektedir ve istenmeyen sonuçlara yol açabilir. Örneğin, devralma ve kuruluş yapısındaki kullanıcılar hakkında daha fazla bilgi için yönetim yardım merkezini ziyaret edin.
  • Kuruluş birimi, hiyerarşik bir ağaçta yukarı veya aşağı taşınabilir. Ayrıca, yeni bir kuruluş doldurulurken ya da bir kullanıcı alt kümesi bir kuruluş biriminden diğerine taşınırken kuruluşun ilişkili kullanıcıları tek tek veya toplu olarak taşınabilir.
  • Kuruluş birimi özelliklerinde saklanan veriler sürekli olarak değişebilir. İstekte bulunurken bir varlık için döndürülen özelliklerin, varlığın alındığı anda tutarlı olması garanti edilir. Yani, "kısmi" ifadesini görmezsiniz. güncellemelerine göz atın. Bir alma işlemi birden fazla varlık döndürürse varlıklar arasında tutarlılık garantisi verilmez.Bu durum özellikle yanıt sayfalara ayırmada birden fazla sayfayı kapsıyorsa geçerlidir.

Kuruluş birimi oluşturma

Kuruluş birimi oluşturmak için aşağıdaki POST isteğini kullanın ve İstekleri yetkilendirme başlıklı makalede açıklanan yetkilendirmeyi dahil edin.

Kuruluş birimi oluşturan bir yöneticiyseniz my_customer politikasını kullanın.

POST https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits

Yeniden satış yapılan bir müşteri için kuruluş birimi oluşturan bayiyseniz customerId öğesini kullanın. customerId öğesini almak için Kullanıcı alma işlemini kullanın.

POST https://admin.googleapis.com/admin/directory/v1/customer/customerId/orgunits

Hesabınızın kuruluş yapısını öğrenmek için Yönetici yardım merkezi sayfasına göz atın. İstek ve yanıt özellikleri için API Referansı'na bakın.

JSON isteği

Aşağıdaki JSON bayi örneğinde, sales_support kuruluş birimini oluşturan örnek bir istek gövdesi gösterilmektedir. name ve parentOrgUnitPath zorunludur: 

POST https://admin.googleapis.com/admin/directory/v1/customer/C03az79cb/orgunits

{
    "name": "sales_support",
    "description": "The sales support team",
    "parentOrgUnitPath": "/corp/support",
    "blockInheritance": false
}

JSON yanıtı

Başarılı bir yanıt, HTTP 201 durum kodu döndürür. Yanıt, durum koduyla birlikte yeni gruba ilişkin özellikleri döndürür: 

{
    "kind": "directory#orgUnit",
    "name": "sales_support",
    "description": "The sales support team",
    "orgUnitPath": "/corp/support/sales_support",
    "parentOrgUnitPath": "/corp/support",
    "blockInheritance": false
  }

Kuruluş birimini güncelleme

Bir kuruluş birimini güncellemek için aşağıdaki PUT isteğini kullanın ve İstekleri yetkilendirme başlıklı makalede açıklanan yetkilendirmeyi dahil edin. İstek ve yanıt özellikleri için API Referansı'na bakın:

Bir kuruluş birimini güncelleyen bir yöneticiyseniz my_customer politikasını kullanın.

 PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits/orgUnitPath

Yeniden satış yapılan bir müşterinin kuruluş birimini güncelleyen bir bayiyseniz customerId özelliğini kullanın. customerId değerini almak için Kullanıcı alma işlemini kullanın.

PUT https://admin.googleapis.com/admin/directory/v1/customer/customerId/orgunits/orgUnitPath

JSON isteği

Aşağıdaki örnekte, kuruluş birimi açıklaması güncellendi: 

PUT https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits/corp/support/sales_support

{
    "description": "The BEST sales support team"
}

Güncelleme isteğiyle ilgili notlar:

  • İsteğinizde yalnızca güncel bilgileri göndermeniz gerekir. Grubun tüm özelliklerini istekte girmenize gerek yoktur.
  • Bir kullanıcı, kullanıcı hesabı oluşturulduğunda belirli bir kuruluş birimine atanmadıysa hesap en üst düzey kuruluş biriminde olur.
  • İstekte parentOrgUnitPath özelliğini ayarlayarak bir kuruluş birimini hesabınızın kuruluş yapısının başka bir bölümüne taşıyabilirsiniz. Bir kuruluş biriminin taşınması, taşınan kuruluş birimindeki kullanıcıların hizmetleri ve ayarlarını değiştirebilir.

JSON yanıtı

Başarılı bir yanıt, HTTP 201 durum kodu döndürür. Yanıt, durum koduyla birlikte güncellenen kuruluş birimine ilişkin özellikleri döndürür. 

{
    "kind": "directory#orgUnit",
    "name": "sales_support",
    "description": "The BEST sales support team",
    "orgUnitPath": "/corp/support/sales_support",
    "parentOrgUnitPath": "/corp/support",
    "blockInheritance": false
}

Bir kullanıcı, kullanıcı hesabı oluşturulduğunda belirli bir kuruluş birimine atanmadıysa hesap en üst düzey kuruluş biriminde olur. Kullanıcının kuruluş birimi, hangi Google Workspace hizmetlerine erişebileceğini belirler. Kullanıcı yeni bir kuruluşa taşınırsa kullanıcının erişimi değişir. Kuruluş yapıları hakkında daha fazla bilgi edinmek için yönetim yardım merkezine göz atın. Bir kullanıcıyı farklı bir kuruluşa taşıma hakkında daha fazla bilgi edinmek için Kullanıcıyı güncelleme başlıklı makaleye göz atın.

Kuruluş birimi alma

Bir kuruluş birimini almak için aşağıdaki GET isteğini kullanın ve İstekleri yetkilendirme başlıklı makalede açıklanan yetkilendirmeyi dahil edin. orgUnitPath sorgu dizesi, bu kuruluş biriminin tam yoludur. İstek ve yanıt özellikleri için API Referansı'na bakın:

Kuruluş birimi alan bir yöneticiyseniz my_customer politikasını kullanın.

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits/orgUnitPath

Yeniden satış yapılan bir müşteri için kuruluş birimi alan bir bayiyseniz customerId özelliğini kullanın. customerId değerini almak için Kullanıcı alma işlemini kullanın.

GET https://admin.googleapis.com/admin/directory/v1/customer/customerId/orgunits/orgUnitPath

JSON yanıtı

Aşağıdaki örnekte "ön saflarda satışlar" kuruluş birimi alındı. "Ön saflarda+satış"a dikkat edin. İsteğin URI'sinde HTTP kodlaması: 

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits/corp/sales/frontline+sales

Başarılı bir yanıt, HTTP 200 durum kodu döndürür. Yanıt, durum koduyla birlikte kuruluş biriminin ayarlarını döndürür: 

{
    "kind": "directory#orgUnit",
    "name": "frontline sales",
    "description": "The frontline sales team",
    "orgUnitPath": "/corp/sales/frontline sales",
    "parentOrgUnitPath": "/corp/sales",
    "blockInheritance": false
}

Kuruluş birimlerini alma

Bir kuruluş birimindeki tüm alt kuruluş birimlerini, kuruluş biriminin ilk alt kuruluşlarını veya tüm alt kuruluş birimlerini ve tüm alt kuruluş birimlerini almak için aşağıdaki GET isteğini kullanın ve İstekleri yetkilendirme başlıklı makalede açıklanan yetkilendirmeyi dahil edin. İstek ve yanıt özellikleri için API Referansı'na bakın.

Tüm alt kuruluş birimlerini alan bir hesap yöneticisiyseniz my_customer politikasını kullanın. Bu örnekte okunabilirlik için satır sonları kullanılmaktadır: 

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer
/orgunits?orgUnitPath=full org unit path&type=all or children or all_including_parent

Yeniden satış yapılan bir müşterinin kuruluş birimlerini alan bir bayiyseniz customerId özelliğini kullanın. customerId değerini almak için Kullanıcı alma işlemini kullanın: 

GET https://admin.googleapis.com/admin/directory/v1/customer/customerId
/orgunits?orgUnitPath=full org unit path&type=all or children or all_including_parent

get sorgu dizesi, all_including_parent için orgUnitPath altındaki all alt kuruluş birimini, orgUnitPath öğesinin hemen children alt kuruluş birimini veya tüm alt kuruluş birimlerini ve belirtilen orgUnitPath değerini döndürür. Varsayılan değer: type=children.

JSON yanıtı

Örneğin, bu istek /corp adlı kuruluş biriminden başlayan tüm kuruluş birimlerini döndürür: 

GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits?orgUnitPath=/corp&type=all

Başarılı bir yanıt, HTTP 200 durum kodu döndürür. Yanıt, durum koduyla birlikte hesabın kuruluş birimlerini döndürür: 

{
"kind": "directory#orgUnits",
    "organizationUnits": [
     {
    "kind": "directory#orgUnit",
    "name": "sales",
    "description": "The corporate sales team",
    "orgUnitPath": "/corp/sales",
    "parentOrgUnitPath": "/corp",
    "blockInheritance": false
     },
     {
    "kind": "directory#orgUnit",
    "name": "frontline sales",
    "description": "The frontline sales team",
    "orgUnitPath": "/corp/sales/frontline sales",
    "parentOrgUnitPath": "/corp/sales",
    "blockInheritance": false
     },
     {
    "kind": "directory#orgUnit",
    "name": "support",
    "description": "The corporate support team",
    "orgUnitPath": "/corp/support",
    "parentOrgUnitPath": "/corp",
    "blockInheritance": false
     },
     {
    "kind": "directory#orgUnit",
    "name": "sales_support",
    "description": "The BEST support team",
    "orgUnitPath": "/corp/support/sales_support",
    "parentOrgUnitPath": "/corp/support",
    "blockInheritance": false
     }
  ]
  }

Kuruluş birimini silme

Bir kuruluş birimini silmek için aşağıdaki DELETE isteğini kullanın ve İstekleri yetkilendirme başlıklı makalede açıklanan yetkilendirmeyi dahil edin. customerId öğesini almak için Kullanıcı alma işlemini kullanın. İstek ve yanıt özellikleri için API Referansı'na bakın:

Bir kuruluş birimini silen hesap yöneticisiyseniz my_customer politikasını kullanın. 

DELETE https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits/orgUnitPath

Yeniden satış yapılan bir müşterinin kuruluş birimini silen bir bayiyseniz customerId özelliğini kullanın. customerId değerini almak için Kullanıcı alma işlemini kullanın. 

DELETE https://admin.googleapis.com/admin/directory/v1/customer/customerId/orgunits/orgUnitPath
 Örneğin, bu bayi yöneticisinin DELETE isteği 'backend_tests'i siler kuruluş birimi: 
DELETE https://admin.googleapis.com/admin/directory/v1/customer/C03az79cb/orgunits/corp/sales/backend_tests

Başarılı bir yanıt, HTTP 200 durum kodu döndürür.

Yalnızca alt kuruluş birimi veya atanmış kullanıcısı olmayan kuruluş birimlerini silebilirsiniz. Silmeden önce kullanıcıları yeniden diğer kuruluş birimlerine atamanız ve alt kuruluş birimlerini kaldırmanız gerekir.