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ıda yönetmenize olanak tanıyan kuruluş birimlerinden oluşur. Bu işlev, Google Yönetici Konsolu'nun "Kuruluşlar ve kullanıcılar" sekmesinde bulunan işlevle benzerdir. Müşterinin kuruluş birimi hiyerarşisi en fazla 35 düzey derinliğe sahip olabilir. Daha fazla bilgi için Yönetici Yardım Merkezi'ne göz atın.

  • Bir Google Workspace hesabına yalnızca bir kuruluş ağacı bağlanabilir. Bu hesap ilk kez yapılandırıldığında hesap düzeyinde bir kuruluş birimi olur. Bu, birincil alanla ilişkili kuruluştur. Birincil alan hakkında daha fazla bilgi için API sınırları bilgileri başlıklı makaleyi inceleyin.
  • Kuruluş biriminin yol adı benzersizdir. Kuruluş biriminin adı, kuruluş hiyerarşisinde benzersiz olmayabilir ancak kardeş kuruluş birimleri arasında benzersizdir. Kuruluş biriminin adı ise büyük/küçük harfe duyarlı değildir.
  • Kuruluş birimleri, politikaları kuruluş hiyerarşisinden devralır. Herhangi bir kuruluş birimi, devralınan politikayı geçersiz kılarak bu üst kuruluş birimi devralma zincirini engelleyebilir. Bir politikanın diğerine göre önceliği, en yakın kuruluş birimi tarafından belirlenir. Bu nedenle, daha alt bir kuruluş biriminin politikaları, daha üst düzeydeki üst kuruluş birimlerinin politikalarına göre öncelikli olabilir. Kuruluş yapısındaki devralma ve kullanıcılar hakkında daha fazla bilgi için yönetim yardım merkezine bakın.
  • Kuruluş birimleri, hiyerarşik ağaçta yukarı veya aşağı taşınabilir. Ayrıca, kuruluşun ilişkili kullanıcıları, yeni bir kuruluş oluşturulurken veya kullanıcıların bir alt kümesi bir kuruluş biriminden diğerine taşınırken tek tek ya da toplu olarak taşınabilir.
  • Kuruluş birimi özelliklerinde tutulan veriler sürekli olarak değişebilir. İstek gönderirken bir varlık için döndürülen özelliklerin, varlık alındığı sırada tutarlı olduğu garanti edilir.Yani "kısmi" güncellemeler görmezsiniz. Bir alma işlemi birden fazla öğe döndürürse öğeler arasında tutarlılık garantisi verilmez.Bu durum, özellikle bir yanıt sayfalara ayırma işleminde birden fazla sayfayı kapsadığında geçerlidir.

Kuruluş birimi oluşturma

Kuruluş birimi oluşturmak için aşağıdaki POST isteğini kullanın ve İstekleri yetkilendirme bölümünde açıklanan yetkilendirmeyi ekleyin.

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

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

Yeniden satılan bir müşteri için kuruluş birimi oluşturan bir bayiyseniz customerId simgesini kullanın. customerId değerini 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ı anlamak için Yönetici Yardım Merkezi'ne bakı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 gereklidir: 

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

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

JSON yanıtı

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

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

Kuruluş birimini güncelleme

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

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

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

Yeniden satılan bir müşterinin kuruluş birimini güncelleyen bir satıcıysanız customerId 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üncellenmiştir: 

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üncellenmiş bilgileri göndermeniz gerekir. İstekte grubun tüm özelliklerini girmeniz gerekmez.
  • Kullanıcı hesabı oluşturulurken belirli bir kuruluş birimine atanmamışsa hesap, üst düzey kuruluş birimindedir.
  • İ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ş birimini taşımanın, taşınan kuruluş birimindeki kullanıcıların hizmetlerini ve ayarlarını değiştirebileceğini unutmayın.

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ş biriminin özelliklerini döndürür. 

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

Kullanıcı hesabı oluşturulurken belirli bir kuruluş birimine atanmamışsa hesap, üst düzey kuruluş birimindedir. Bir kullanıcının kuruluş birimi, kullanıcının hangi Google Workspace hizmetlerine erişebileceğini belirler. Kullanıcı yeni bir kuruluşa taşınırsa erişimi değişir. Kuruluş yapıları hakkında daha fazla bilgi için Yönetici Yardım Merkezi'ne bakın. Bir kullanıcıyı farklı bir kuruluşa taşıma hakkında daha fazla bilgi için Kullanıcıyı güncelleme başlıklı makaleyi inceleyin.

Kuruluş birimini alma

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

Bir kuruluş birimini alan bir yöneticiyseniz my_customer kullanın.

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

Yeniden satılan bir müşteri için kuruluş birimi alan bir satıcıysanız customerId kullanın. değerini almak için Kullanıcı alma işlemini kullanın.customerId

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

JSON yanıtı

Aşağıdaki örnekte "ön cephe satış" kuruluş birimi alınır. İsteğin URI 'sindeki "frontline+sales" HTTP kodlamasına dikkat edin: 

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"
}

Kuruluş birimlerini alma

Bir kuruluş biriminin altındaki tüm alt kuruluş birimlerini, bir kuruluş biriminin altındaki doğrudan alt kuruluş birimlerini veya tüm alt kuruluş birimlerini ve belirtilen kuruluş birimini almak için aşağıdaki GET isteğini kullanın ve İstekleri yetkilendirme bölümünde 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 kullanın. Okunabilirliği artırmak açısından bu örnekte satır sonları kullanılmıştı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ılan bir müşteri için kuruluş birimlerini alan bir bayiyseniz customerId 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ş birimlerini, orgUnitPath'nin doğrudan children'ünü veya tüm alt kuruluş birimlerini ve belirtilen orgUnitPath'yi döndürür. Varsayılan değer type=children'dir.

JSON yanıtı

Örneğin, bu istek /corp kuruluş biriminden başlayarak 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"
     },
     {
    "kind": "directory#orgUnit",
    "name": "frontline sales",
    "description": "The frontline sales team",
    "orgUnitPath": "/corp/sales/frontline sales",
    "parentOrgUnitPath": "/corp/sales"
     },
     {
    "kind": "directory#orgUnit",
    "name": "support",
    "description": "The corporate support team",
    "orgUnitPath": "/corp/support",
    "parentOrgUnitPath": "/corp"
     },
     {
    "kind": "directory#orgUnit",
    "name": "sales_support",
    "description": "The BEST support team",
    "orgUnitPath": "/corp/support/sales_support",
    "parentOrgUnitPath": "/corp/support"
     }
  ]
  }

Kuruluş birimini silme

Bir kuruluş birimini silmek için aşağıdaki DELETE isteğini kullanın ve İstekleri yetkilendirme bölümünde açıklanan yetkilendirmeyi dahil edin. customerId değerini 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 bir hesap yöneticisiyseniz my_customer simgesini kullanın. 

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

Yeniden satış yapan bir satıcıysanız ve yeniden sattığınız bir müşterinin kuruluş birimini siliyorsanız customerId simgesini kullanın. değerini almak için Kullanıcı alma işlemini kullanın.customerId 

DELETE https://admin.googleapis.com/admin/directory/v1/customer/customerId/orgunits/orgUnitPath
 Örneğin, bu bayi yöneticisinin DELETE isteği "backend_tests" kuruluş birimini siler: 
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 kullanıcı atanmamış kuruluş birimlerini silebilirsiniz. Silmeden önce kullanıcıları diğer kuruluş birimlerine yeniden atamanız ve alt kuruluş birimlerini kaldırmanız gerekir.