Directory API: Kuruluş Birimleri

Kuruluş birimlerini yönetme

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, Yönetici konsolunun "Kuruluşlar ve kullanıcılar" sekmesinde bulunan işleve benzer. 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 kez yapılandırıldığında, hesap düzeyinde bir kuruluş birimi vardır. Bu, birincil alanla ilişkili kuruluştur. Birincil alan hakkında daha fazla bilgi için API sınırları bilgilerine bakın.
  • Kuruluş biriminin yol adı benzersizdir. Kuruluş biriminin adı, kuruluş hiyerarşisinde benzersiz olmayabilir ancak adı kardeş kuruluş birimleri arasında benzersizdir. Ayrıca, kuruluş biriminin adı büyük/küçük harfe duyarlı değildir.
  • Bir kuruluş birimi, politikaları kuruluş hiyerarşisinden devralır. Tüm kuruluş birimleri, devralınan politikayı geçersiz kılarak bu ebeveyn devralma zincirini engelleyebilir. Bir politikanın diğerine göre önceliği en yakın kuruluş birimi tarafından belirlenir. Bu, daha düşük bir kuruluş biriminin politikalarının, daha üst düzey ebeveyn birimlerinin politikalarına göre öncelikli olabileceği anlamına gelir. blockInheritance ayarı, bir kuruluş birimi ve alt kuruluşu için ayar devralma işleminin engellenmesine olanak tanır. blockInheritance desteği sonlandırıldı. Değerin "true" (doğru) olarak ayarlanması artık desteklenmemektedir ve bu durum istenmeyen sonuçlara yol açabilir. Kuruluş yapısındaki kullanıcılar ve devralma hakkında daha fazla bilgi edinmek için yönetim yardım merkezine göz atın.
  • Bir kuruluş birimi, hiyerarşik ağaçta yukarı veya aşağı taşınabilir. Ayrıca, yeni bir kuruluş doldurulurken veya kullanıcıların bir alt kümesi bir kuruluş biriminden diğerine taşınırken, kuruluşla ilişkili kullanıcılar tek tek veya grup halinde taşınabilir.
  • Kuruluş birimi mülklerinde saklanan veriler sürekli olarak değişebilir. İstekte bulunurken bir varlık için döndürülen özelliklerin, varlığın alındığı zamanda tutarlı olması garanti edilir.Yani, "kısmi" güncellemeleri görmezsiniz. Alma işlemi birden fazla varlık döndürürse varlıklar arasında tutarlılık garantisi verilmez.Bu durum özellikle bir 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 bölümünde açıklanan yetkilendirmeyi dahil edin.

Yöneticiyseniz kuruluş birimi oluştururken my_customer 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 özelliğini kullanın. customerId bilgisini 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 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, bir 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",
    "blockInheritance": false
  }

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 dahil edin. İstek ve yanıt özellikleri için API Referansı'na bakın:

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

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

Yeniden satış yapılan bir müşteri için kuruluş birimini güncelleyen bir bayiyseniz customerId özelliğini kullanın. customerId bilgisini 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üncel bilgileri göndermeniz gerekir. Grubun tüm özelliklerini isteğe girmeniz gerekmez.
  • Kullanıcı, kullanıcı hesabı oluşturulduğunda belirli bir kuruluş birimine atanmadıysa hesap en ü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şınmakta olan kuruluş birimindeki kullanıcılar için hizmet ve ayarları değiştirebileceğini unutmayın.

JSON yanıtı

Başarılı bir yanıt, bir 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
}

Kullanıcı, kullanıcı hesabı oluşturulduğunda belirli bir kuruluş birimine atanmadıysa hesap en ü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 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. Kullanıcıyı farklı bir kuruluşa taşıma hakkında daha fazla bilgi edinmek için Kullanıcı güncelleme başlıklı makaleyi inceleyin.

Bir 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 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 öğesini 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ış" kuruluş birimi alınmıştır. İsteğin URI 'sında "frontline+sales" HTTP kodlamasını not edin:

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

Başarılı bir yanıt, bir 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 al

Bir kuruluş birimindeki tüm alt kuruluş birimlerini, bir kuruluş biriminin hemen altındaki alt kuruluş birimlerini veya tüm alt kuruluş birimleri ile 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 alanını kullanın. Okunabilirlik için bu örnekte satır sonuçları 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 öğesini 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 orgUnitPath altındaki all alt kuruluş birimini, orgUnitPath öğesinin hemen children alt kuruluş birimini veya tüm alt kuruluş birimlerini ve all_including_parent için belirtilen orgUnitPath kuruluş birimini 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, bir 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 bölümünde açıklanan yetkilendirmeyi dahil edin. customerId bilgisini almak için Kullanıcı alma işlemini kullanın. İstek ve yanıt özellikleri için API Referansı'na bakın:

Hesap yöneticisiyseniz ve bir kuruluş birimini siliyorsanız my_customer 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 öğesini almak için Kullanıcı alma işlemini kullanın.

DELETE https://admin.googleapis.com/admin/directory/v1/customer/customerId/orgunits/orgUnitPath
Örneğin, şu 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, bir 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ı başka kuruluş birimlerine yeniden atamanız ve alt kuruluş birimlerini kaldırmanız gerekir.