Directory API: Kuruluş Birimleri

Kuruluş birimlerini yönetme

Bir Google Workspace hesabının kuruluş ağacı, kullanıcılarınızı mantıklı ve hiyerarşik bir yapıda yönetmenize olanak tanıyan kuruluş birimlerinden oluşur. Bu, Yönetici Konsolu'nun "Kuruluşlar ve kullanıcılar" sekmesinde bulunan işleve benzer. Müşterinin kuruluş birimi hiyerarşisi 35 düzey derinliğiyle sınırlıdır. Daha fazla bilgi için Yönetici Yardım Merkezi'ne göz atın.

  • Google Workspace hesaplarında yalnızca bir kuruluş ağacı bulunur. Bu hesap ilk 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ırlamaları hakkında başlıklı makaleyi inceleyin.
  • Bir kuruluş biriminin yol adı benzersizdir. Kuruluş biriminin adı, kuruluş hiyerarşisi içinde benzersiz olmayabilir ancak adı, kardeş kuruluş birimleri arasında benzersizdir. Kuruluş biriminin adı büyük/küçük harf duyarlı değildir.
  • Bir kuruluş birimi, kuruluş hiyerarşisindeki politikaları devralır. Herhangi bir kuruluş birimi, devralınan politikayı geçersiz kılarak bu üst kuruluş devralma zincirini engelleyebilir. Bir politikanın diğerine göre önceliği en yakın kuruluş birimi tarafından belirlenir. Yani bir alt kuruluş biriminin politikaları, daha yüksek ebeveyn birimlerinin politikalarına göre öncelikli olabilir. Bir kuruluş yapısındaki devralma ve kullanıcılar hakkında daha fazla bilgi için yönetim yardım merkezine göz atın.
  • Kuruluş birimi, hiyerarşik bir ağaçta yukarı veya aşağı taşınabilir. Ayrıca, yeni bir kuruluş doldururken veya kullanıcıların bir alt kümesini bir kuruluş biriminden başka bir kuruluş birimine taşı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" güncellemeler görmezsiniz. Bir getirme işlemi birden fazla öğe döndürürse öğeler arasında tutarlılık garantisi yoktur.Bu durum özellikle sayfalara ayırma işleminde bir yanıt 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 ekleyin.

Kuruluş birimi oluşturan bir yöneticiyseniz my_customer değerini kullanın.

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

Bayi olarak, yeniden satılan bir müşteri için kuruluş birimi oluşturuyorsanız customerId değerini 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 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 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 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ılan bir müşterinin kuruluş birimini güncelleyen bir bayiyseniz customerId değerini 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ş biriminin 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 yeterlidir. Grubun tüm özelliklerini istekte girmenize gerek yoktur.
  • Kullanıcı hesabı oluşturulurken belirli bir kuruluş birimine atanmamışsa hesap üst düzey kuruluş birimindedir.
  • İstekte parentOrgUnitPath mülkünü 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ıtta HTTP 201 durum kodu döndürülü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"
}

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 hangi Google Workspace hizmetlerine erişebileceğini kullanıcının kuruluş birimi 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önetim yardım merkezine göz atın. Kullanıcıları farklı bir kuruluşa taşıma hakkında daha fazla bilgi için Kullanıcıları 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 değerini 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 bayiyseniz customerId değerini 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 saf satış" kuruluş birimi getirilmektedir. İsteğin URI 'sindeki "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ıtta HTTP 200 durum kodu döndürülü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şları veya tüm alt kuruluş birimlerinin yanı sıra 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 değerini kullanın. Okunabilirliği artırmak için 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ş birimleri alan bir bayiyseniz customerId değerini 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, orgUnitPath altındaki all alt kuruluş birimini, orgUnitPath'nin doğrudan children'ını veya tüm alt kuruluş birimlerini ve all_including_parent için belirtilen orgUnitPath'yi döndürür. Varsayılan değer: type=children.

JSON yanıtı

Örneğin, bu istek /corp kuruluş biriminden itibaren 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 hesap yöneticisiyseniz my_customer politikasını kullanın. 

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

Yeniden satılan bir müşteri için kuruluş birimini silen bir bayiyseniz customerId simgesini 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" kuruluş birimini siler: 
DELETE https://admin.googleapis.com/admin/directory/v1/customer/C03az79cb/orgunits/corp/sales/backend_tests

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

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