অ্যাডমিন সেটিংস API ওভারভিউ

অ্যাডমিন সেটিংস এপিআই গুগল ওয়ার্কস্পেস ডোমেইনের অ্যাডমিনিস্ট্রেটরদেরকে গুগল ডেটা এপিআই ফিডের আকারে তাদের ডোমেইনের সেটিংস পুনরুদ্ধার এবং পরিবর্তন করার সুযোগ দেয়।

এই ডোমেইন সেটিংসে গুগল ওয়ার্কস্পেস অ্যাডমিন কনসোলে উপলব্ধ অনেক বৈশিষ্ট্য অন্তর্ভুক্ত রয়েছে। এই এপিআই-এর ব্যবহারের উদাহরণগুলির মধ্যে রয়েছে একটি কাস্টম কন্ট্রোল প্যানেল তৈরি করা অথবা একটি বিদ্যমান লিগ্যাসি পরিবেশে গুগল ওয়ার্কস্পেস ডোমেইনগুলিকে একীভূত করা।

অ্যাডমিন সেটিংস এপিআই, গুগল ডেটা এপিআই প্রোটোকল বাস্তবায়ন করে। গুগল ডেটা এপিআই, অ্যাটম পাবলিশিং প্রোটোকল (অ্যাটমপাব)-এর পাবলিশিং এবং এডিটিং মডেল অনুসরণ করে। অ্যাটমপাব এইচটিটিপি রিকোয়েস্টগুলো ওয়েব সার্ভিসের জন্য রিপ্রেজেন্টেশনাল সেট ট্রান্সফার (রেস্টফুল) ডিজাইন অ্যাপ্রোচ ব্যবহার করে। আরও তথ্যের জন্য, গুগল ডেটা এপিআই ডেভেলপারস গাইড দেখুন।

দর্শক

এই ডকুমেন্টটি সেইসব ডেভেলপারদের জন্য, যারা গুগল ওয়ার্কস্পেস ডোমেইন সম্পর্কিত তথ্য পরিবর্তন ও পুনরুদ্ধার করতে পারে এমন ক্লায়েন্ট অ্যাপ্লিকেশন লিখতে চান। এতে র XML এবং HTTP ব্যবহার করে বেসিক অ্যাডমিন সেটিংস API ইন্টারঅ্যাকশনের উদাহরণ দেওয়া হয়েছে।

এই ডকুমেন্টটি ধরে নেয় যে আপনি গুগল ডেটা এপিআই প্রোটোকলের পেছনের সাধারণ ধারণাগুলো বোঝেন এবং গুগল ওয়ার্কস্পেস অ্যাডমিন কনসোলের সাথে পরিচিত। অ্যাডমিন কনসোল সম্পর্কে আরও তথ্যের জন্য, “আপনার অ্যাডমিন কনসোল ব্যবহার করুন” দেখুন।

শুরু করুন

অ্যাডমিন সেটিংস এপিআই ব্যবহার শুরু করতে, প্রথমে আপনার অ্যাকাউন্ট তৈরি করুন।

একটি অ্যাকাউন্ট তৈরি করুন

গুগল ওয়ার্কস্পেস অ্যাকাউন্টগুলোর জন্য অ্যাডমিন সেটিংস এপিআই সক্রিয় করা হয়েছে। পরীক্ষার উদ্দেশ্যে একটি গুগল ওয়ার্কস্পেস অ্যাকাউন্টের জন্য সাইন আপ করুন। অ্যাডমিন সেটিংস পরিষেবাটি গুগল অ্যাকাউন্ট ব্যবহার করে, তাই গুগল ওয়ার্কস্পেস ডোমেইনে আপনার যদি আগে থেকেই একটি অ্যাকাউন্ট থাকে, তাহলেই চলবে।

অ্যাডমিন সেটিংস এপিআই ফিডের প্রকারভেদ সম্পর্কে

অ্যাডমিন সেটিংস এপিআই আপনাকে ডোমেইন সেটিংসের এই বিভাগগুলি পরিচালনা করতে দেয়:

একক সাইন-অন সেটিংস
SAML-ভিত্তিক সিঙ্গেল সাইন-অন (SSO) ব্যবহারকারীদের Google Workspace-এ হোস্ট করা পরিষেবাগুলির পাশাপাশি আপনার প্রতিষ্ঠানের হোস্ট করা অন্যান্য পরিষেবাগুলির জন্যও একই লগইন এবং পাসওয়ার্ড ব্যবহার করার সুযোগ দেয়। বিশেষত SSO ব্যবহার করার সময়, Google Workspace-এর মতো একটি হোস্ট করা ওয়েব অ্যাপ্লিকেশন, ব্যবহারকারীরা সাইন ইন করার সময় তাদের প্রমাণীকরণের জন্য আপনার প্রতিষ্ঠানের আইডেন্টিটি প্রোভাইডারের কাছে পাঠিয়ে দেয়। বিস্তারিত তথ্যের জন্য, "Understanding SAML-based SSO for Google Workspace " দেখুন।

SSO কনফিগার করার জন্য Google Workspace পরিষেবাটিকে আপনার ব্যবহারকারীদের লগইন তথ্য সংরক্ষণকারী আইডেন্টিটি প্রোভাইডারের সাথে যোগাযোগ করার জন্য প্রয়োজনীয় তথ্য প্রবেশ করাতে হয়। এছাড়াও, ব্যবহারকারীদের লগইন, লগআউট এবং পাসওয়ার্ড পরিবর্তনের জন্য যে লিঙ্কগুলিতে পাঠানো হবে, সেগুলিও সেট আপ করতে হয়। অ্যাডমিন সেটিংস এপিআই (Admin Settings API) আপনাকে প্রোগ্রাম্যাটিকভাবে এই সেটিংস আপডেট এবং পুনরুদ্ধার করার সুযোগ দেয়। Google আপনার তৈরি করা পাবলিক কী ব্যবহার করে আপনার আইডেন্টিটি প্রোভাইডারের সাথে এই SSO অনুরোধটি যাচাই করে এবং এটিও নিশ্চিত করে যে নেটওয়ার্ক ট্রান্সমিশনের সময় প্রাইভেট কী SAML রেসপন্সটি পরিবর্তিত হয়নি।

SSO সেটিংস ব্যবহারের একটি সংক্ষিপ্ত API-নির্দিষ্ট সারসংক্ষেপের জন্য, আপনার আইডেন্টিটি প্রোভাইডারের কাছ থেকে আপনার পাবলিক কী সার্টিফিকেটটি নিন, Google-এর সাথে পাবলিক কী-টি রেজিস্টার করুন, এবং আপনার SAML-ভিত্তিক SSO কোয়েরি সেটিংস সেট আপ করুন। ত্রুটির বার্তার জন্য, SSO ট্রাবলশুটিং দেখুন।

  • আপনার কী তৈরি করুন -- আপনার আইডেন্টিটি প্রোভাইডারের সাথে, DSA বা RSA অ্যালগরিদম ব্যবহার করে এক সেট পাবলিক এবং প্রাইভেট কী তৈরি করুন। পাবলিক কী একটি X.509 ফরম্যাটের সার্টিফিকেটে থাকে। SAML-ভিত্তিক সিঙ্গেল সাইন-অন সাইনিং কী সম্পর্কে আরও তথ্যের জন্য, "Google Workspace Single Sign-On Service-এর জন্য কী এবং সার্টিফিকেট তৈরি করা" দেখুন।
  • গুগলে নিবন্ধন করুন -- আপনার পাবলিক কী সার্টিফিকেটটি গুগলে নিবন্ধন করতে অ্যাডমিন সেটিংস এপিআই-এর সিঙ্গেল সাইন-অন সেটিংস ব্যবহার করুন।
  • আপনার SSO সেটিংস সেট আপ করুন -- ডোমেইনের আইডেন্টিটি প্রোভাইডারের সার্ভারগুলোর সাথে যোগাযোগের জন্য ব্যবহৃত সেটিংস কনফিগার করতে অ্যাডমিন সেটিংস API-এর সিঙ্গেল সাইন-অন সেটিংস ব্যবহার করুন।

গেটওয়ে এবং রাউটিং সেটিংস

এই ফিডের মাধ্যমে ডোমেইন অ্যাডমিনিস্ট্রেটররা তাদের ডোমেইনগুলোর ইমেইল রাউটিং নিয়ন্ত্রণ করতে পারেন।

ইমেল রাউটিং অপারেশন অ্যাডমিনিস্ট্রেটরদের ডোমেইন-স্তরের ইমেল রাউটিং সেটিংস নির্দিষ্ট করার সুযোগ দেয়। এটি অ্যাডমিন কনসোলের জিমেইল সেটিংসের ইমেল রাউটিং কার্যকারিতার অনুরূপ। আরও তথ্যের জন্য, ইমেল রাউটিং এবং ইমেল রাউটিং ফিচারের ডুয়াল ডেলিভারি কনফিগারেশন দেখুন।

অ্যাডমিন সেটিংস এপিআই এক্সএমএল অনুরোধ এবং প্রতিক্রিয়ার একটি নমুনা

এই ডকুমেন্টটিতে র XML এবং HTTP ব্যবহার করে বেসিক অ্যাডমিন সেটিংস API রিকোয়েস্ট ও রেসপন্সের কোড উদাহরণ দেওয়া হয়েছে। এই ডোমেইন ডিফল্ট ল্যাঙ্গুয়েজের উদাহরণটি একটি রিকোয়েস্ট এবং রেসপন্স এন্ট্রির বডির জন্য সম্পূর্ণ XML এবং HTTP সিনট্যাক্স দেখায়, যা প্রতিটি অপারেশনের জন্য সাধারণ:

ডোমেইনের আউটবাউন্ড ইমেল গেটওয়ে সেটিং পরিবর্তন করতে, গেটওয়ে ফিড URL-এ একটি HTTP PUT পাঠান:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

ডোমেইনের ডিফল্ট ভাষা PUT অনুরোধের AtomPub entry XML হলো:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom'
  xmlns:apps='http://schemas.google.com/apps/2006'>
  <apps:property name='smartHost' value='smtp.out.domain.com' />
  <apps:property name='smtpMode' value='SMTP' />
</atom:entry>

অপারেশন-নির্দিষ্ট প্রোপার্টি এবং ভ্যালুগুলো ছাড়া, atom:property এলিমেন্টটি একটি একক কী-ভ্যালু পেয়ারকে উপস্থাপন করে, যা এমন একটি প্রোপার্টি সম্পর্কিত তথ্য ধারণ করে যা আপনি পুনরুদ্ধার বা আপডেট করতে চান। এগুলো সকল অ্যাডমিন সেটিংস এপিআই রিকোয়েস্ট বডির জন্য সাধারণ।

ডোমেইন ডিফল্ট ল্যাঙ্গুয়েজ রেসপন্স entry এলিমেন্টটি smartHost এবং smtpMode প্রপার্টিগুলোর সাথে সকল অ্যাডমিন সেটিংস এপিআই রেসপন্স বডির জন্য সাধারণ এক্সএমএল সিনট্যাক্স রিটার্ন করে:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/domain/2.0/domainName/email/gateway</id>
<updated>2008-12-17T23:59:23.887Z</updated>
<link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</entry>

একক সাইন-অন সেটিংস পরিচালনা করুন

গুগল ওয়ার্কস্পেসের সিঙ্গেল সাইন-অন (SSO) ফিচারটি ব্যবহারকারীদের শুধুমাত্র একবার লগইন এবং পাসওয়ার্ড দিয়েই একাধিক পরিষেবাতে লগ অন করার সুযোগ দেয়। এই পাসওয়ার্ডটি ডোমেইনের আইডেন্টিটি প্রোভাইডার দ্বারা সংরক্ষিত থাকে, গুগল ওয়ার্কস্পেস দ্বারা নয়। আরও তথ্যের জন্য, হেল্প সেন্টারের SSO পৃষ্ঠাটি দেখুন। নিম্নলিখিত বিভাগগুলিতে সিঙ্গেল সাইন-অন সেটিংসের জন্য ব্যবহৃত XML ফরম্যাটটি দেখানো হয়েছে।

একক সাইন-অন সেটিংস পুনরুদ্ধার করুন

সিঙ্গেল সাইন-অন সেটিংস পুনরুদ্ধার করতে, SSO জেনারেল ফিড URL-এ একটি HTTP GET পাঠান এবং 'অ্যাডমিন সেটিংস পরিষেবাতে প্রমাণীকরণ' অংশে বর্ণিত পদ্ধতি অনুযায়ী একটি Authorization হেডার অন্তর্ভুক্ত করুন। আর, ত্রুটির বার্তার জন্য, 'SSO সমস্যা সমাধান' দেখুন।

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

এই অপারেশনটির রিকোয়েস্ট বডিতে কোনো প্যারামিটার নেই।

একটি সফল প্রতিক্রিয়ার ফলে একটি HTTP 200 OK স্ট্যাটাস কোড এবং ডোমেইনটির SSO সেটিংস সহ একটি AtomPub ফিড ফেরত আসে।

GET রেসপন্স XML-টি samlSignonUri , samlLogoutUri , changePasswordUri , enableSSO , ssoWhitelist এবং useDomainSpecificIssuer প্রোপার্টিগুলো রিটার্ন করে:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
...
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='true'/>
<apps:property name='ssoWhitelist' value='CIDR formatted IP address'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

বৈশিষ্ট্যগুলোর মধ্যে রয়েছে:

samlSignonUri
আইডেন্টিটি প্রোভাইডারের ইউআরএল, যেখানে গুগল ওয়ার্কস্পেস ব্যবহারকারীর প্রমাণীকরণের জন্য SAML অনুরোধ পাঠায়।
samlLogoutUri
ওয়েব অ্যাপ্লিকেশন থেকে লগ আউট করার পর ব্যবহারকারীদের যে ঠিকানায় পাঠানো হবে।
পাসওয়ার্ড পরিবর্তন করুন
ওয়েব অ্যাপ্লিকেশনের SSO পাসওয়ার্ড পরিবর্তন করতে চাইলে ব্যবহারকারীদের এই ঠিকানায় পাঠানো হবে।
enableSSO
এই ডোমেনের জন্য SAML-ভিত্তিক SSO সক্ষম করে। আপনি যদি পূর্বে SSO সেটিংস কনফিগার করে থাকেন এবং পরবর্তীতে enableSSO কে enableSSO=false সেট করেন, তাহলেও আপনার পূর্বে প্রবেশ করানো সেটিংস সংরক্ষিত থাকবে।
ssoWhitelist
ssoWhitelist হলো ক্লাসলেস ইন্টার-ডোমেইন রাউটিং (CIDR) ফরম্যাটে থাকা একটি নেটওয়ার্ক মাস্ক আইপি অ্যাড্রেস। ssoWhitelist নির্ধারণ করে কোন ব্যবহারকারীরা SSO ব্যবহার করে এবং কোন ব্যবহারকারীরা Google Workspace অ্যাকাউন্ট অথেন্টিকেশন পেজ ব্যবহার করে সাইন ইন করবেন। যদি কোনো মাস্ক নির্দিষ্ট করা না থাকে, তাহলে সকল ব্যবহারকারী SSO ব্যবহার করে সাইন ইন করবেন। আরও তথ্যের জন্য, “নেটওয়ার্ক মাস্ক কীভাবে কাজ করে” দেখুন।
ডোমেইন-নির্দিষ্ট ইস্যুকারী ব্যবহার করুন
আইডেন্টিটি প্রোভাইডারের কাছে পাঠানো SAML অনুরোধে একটি ডোমেইন-নির্দিষ্ট ইস্যুয়ার ব্যবহার করা যেতে পারে। যদিও বেশিরভাগ SSO ডেপ্লয়মেন্টের জন্য এটি অপরিহার্য নয়, তবে এই ফিচারটি সেইসব বড় কোম্পানির জন্য উপযোগী যারা একাধিক সাবডোমেইন সহ একটি সম্পূর্ণ প্রতিষ্ঠানকে প্রমাণীকরণের জন্য একটিমাত্র আইডেন্টিটি প্রোভাইডার ব্যবহার করে। নির্দিষ্ট ডোমেইন ইস্যুয়ার প্রদান করলে তা নির্ধারণ করে দেয় যে অনুরোধটির সাথে কোন সাবডোমেইনটি যুক্ত করা হবে। আরও তথ্যের জন্য, দেখুন SAML অনুরোধে Issuer এলিমেন্টটি কীভাবে কাজ করে?

যদি কোনো কারণে আপনার অনুরোধ ব্যর্থ হয়, তাহলে একটি ভিন্ন স্ট্যাটাস কোড ফেরত দেওয়া হয়। গুগল ডেটা এপিআই স্ট্যাটাস কোড সম্পর্কে আরও তথ্যের জন্য, HTTP স্ট্যাটাস কোড দেখুন।

একক সাইন-অন সেটিংস আপডেট করুন

একটি ডোমেইনের SSO সেটিংস আপডেট করতে, প্রথমে 'Retrieve Single Sign-On settings' অপারেশনটি ব্যবহার করে SSO সেটিংস পুনরুদ্ধার করুন, এটি পরিবর্তন করুন এবং তারপরে SSO ফিড URL-এ একটি PUT রিকোয়েস্ট পাঠান। নিশ্চিত করুন যে আপনার আপডেট করা এন্ট্রির <id> ভ্যালুটি বিদ্যমান এন্ট্রির <id> এর সাথে হুবহু মিলে যায়। 'Authenticating to the Admin Settings API service'- এ বর্ণিত পদ্ধতি অনুযায়ী একটি Authorization হেডার অন্তর্ভুক্ত করুন। এবং, এরর মেসেজের জন্য, 'Troubleshooting SSO' দেখুন।

সিঙ্গেল সাইন-অন সেটিংস আপডেট করার সময়, SSO জেনারেল ফিড URL-এ একটি HTTP PUT পাঠান:

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

PUT অনুরোধের XML বডিটি হলো:

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='enableSSO' value='false' />
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon' />
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout' />
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword' />
<apps:property name='ssoWhitelist' value='127.0.0.1/32' />
<apps:property name='useDomainSpecificIssuer' value='false'/>
</atom:entry>

একটি সফল প্রতিক্রিয়ার ফলে একটি HTTP 200 OK স্ট্যাটাস কোড এবং SSO সেটিংস সহ একটি AtomPub ফিড ফেরত আসে।

PUT প্রতিক্রিয়া XML হলো:

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='false'/>
<apps:property name='ssoWhitelist' value='127.0.0.1/32'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

যদি কোনো কারণে আপনার অনুরোধ ব্যর্থ হয়, তাহলে একটি ভিন্ন স্ট্যাটাস কোড ফেরত দেওয়া হয়। গুগল ডেটা এপিআই স্ট্যাটাস কোড সম্পর্কে আরও তথ্যের জন্য, HTTP স্ট্যাটাস কোড দেখুন।

যখন টার্গেট কাস্টমার সংবেদনশীল কার্যকলাপের জন্য মাল্টি-পার্টি অনুমোদন সক্রিয় করে রাখেন, তখন সিঙ্গেল সাইন-অন সেটিংসে কোনো পরিবর্তন করার অনুমতি দেওয়া হয় না। অনুরোধগুলি errorCode="1811" এবং reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval" সহ ব্যর্থ হবে।

সিঙ্গেল সাইন-অন সাইনিং কী পুনরুদ্ধার করুন

সিঙ্গেল সাইন-অন সাইনিং কী পুনরুদ্ধার করতে, SSO সাইনিং কী ফিড URL-এ একটি HTTP GET পাঠান এবং 'অ্যাডমিন সেটিংস পরিষেবাতে প্রমাণীকরণ' অংশে বর্ণিত পদ্ধতি অনুযায়ী একটি Authorization হেডার অন্তর্ভুক্ত করুন। আর, ত্রুটির বার্তার জন্য, 'SSO সমস্যা সমাধান' দেখুন।

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

এই অপারেশনটির রিকোয়েস্ট বডিতে কোনো প্যারামিটার নেই।

একটি সফল প্রতিক্রিয়ার ফলে HTTP 200 OK স্ট্যাটাস কোডের সাথে সাইনিং কী-সহ একটি AtomPub ফিড ফেরত আসে।

GET রেসপন্স XML-টি signingKey প্রপার্টিটি রিটার্ন করে: 

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</entry>

যদি কোনো কারণে আপনার অনুরোধ ব্যর্থ হয়, তাহলে একটি ভিন্ন স্ট্যাটাস কোড ফেরত দেওয়া হয়। গুগল ডেটা এপিআই স্ট্যাটাস কোড সম্পর্কে আরও তথ্যের জন্য, HTTP স্ট্যাটাস কোড দেখুন।

সিঙ্গেল সাইন-অন সাইনিং কী আপডেট করুন

একটি ডোমেইনের SSO সাইনিং কী আপডেট করতে, প্রথমে 'Retrieve Single Sign-On signing key' অপারেশনটি ব্যবহার করে সাইনিং কী-টি পুনরুদ্ধার করুন, এটি পরিবর্তন করুন এবং তারপরে SSO সাইনিং কী ফিড URL-এ একটি PUT রিকোয়েস্ট পাঠান। নিশ্চিত করুন যে আপনার আপডেট করা এন্ট্রির <id> ভ্যালুটি বিদ্যমান এন্ট্রির <id> এর সাথে হুবহু মিলে যায়। SAML-ভিত্তিক সিঙ্গেল সাইন-অন সাইনিং কী সম্পর্কে আরও তথ্যের জন্য, 'Generating Keys and Certificates for Google Workspace Single Sign-On Service' দেখুন।

সিঙ্গেল সাইন-অন সাইনিং কী আপডেট করার সময়, SSO সাইনিং কী ফিড URL-এ একটি HTTP PUT পাঠান: 

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

PUT অনুরোধের XML হলো: 

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</atom:entry>

যখন টার্গেট কাস্টমার সংবেদনশীল কার্যকলাপের জন্য মাল্টি-পার্টি অনুমোদন সক্রিয় করে রাখেন, তখন সিঙ্গেল সাইন-অন সেটিংসে কোনো পরিবর্তন করার অনুমতি দেওয়া হয় না। অনুরোধগুলি errorCode="1811" এবং reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval" সহ ব্যর্থ হবে।

ইমেল গেটওয়ে এবং রাউটিং পরিচালনা করুন

আউটবাউন্ড ইমেল গেটওয়ে বিভাগে দেখানো হয়, কীভাবে অ্যাডমিন সেটিংস এপিআই আপনার ডোমেইনের ব্যবহারকারীদের মেইল ​​আউটবাউন্ড রাউটিং সমর্থন করে। ইমেল রাউটিং বিভাগে দেখানো হয়, কীভাবে অন্য একটি মেইল ​​সার্ভারে বার্তা রাউট করতে হয়।

বহির্গামী ইমেল গেটওয়ে সেটিংস পুনরুদ্ধার করুন

আউটবাউন্ড ইমেল গেটওয়ে সেটিংস পুনরুদ্ধার করতে, গেটওয়ে ফিড URL-এ একটি HTTP GET পাঠান এবং 'অ্যাডমিন সেটিংস পরিষেবাতে প্রমাণীকরণ' অংশে বর্ণিত পদ্ধতি অনুযায়ী একটি Authorization হেডার অন্তর্ভুক্ত করুন। 

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

এই অপারেশনটির রিকোয়েস্ট বডিতে কোনো প্যারামিটার নেই।

একটি সফল প্রতিক্রিয়ার ফলে একটি HTTP 200 OK স্ট্যাটাস কোড এবং ইমেল গেটওয়ের স্ট্যাটাস তথ্যসহ একটি AtomPub ফিড ফেরত আসে।

GET রেসপন্সটি smartHost এবং smtpMode প্রপার্টিগুলো রিটার্ন করে। এই প্রপার্টিগুলো সম্পর্কে আরও তথ্যের জন্য, “আউটবাউন্ড ইমেল গেটওয়ে সেটিংস আপডেট করুন” দেখুন।

একটি সম্ভাব্য প্রতিক্রিয়ার উদাহরণ হলো: 

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='smartHost' value='smtpout.domain.com'/>
<apps:property name='smtpMode' value='SMTP'/>
</entry>

যদি কোনো কারণে আপনার অনুরোধ ব্যর্থ হয়, তাহলে একটি ভিন্ন স্ট্যাটাস কোড ফেরত দেওয়া হয়। গুগল ডেটা এপিআই স্ট্যাটাস কোড সম্পর্কে আরও তথ্যের জন্য, HTTP স্ট্যাটাস কোড দেখুন।

আউটবাউন্ড ইমেল গেটওয়ে সেটিংস আপডেট করুন

একটি ডোমেইনের আউটবাউন্ড ইমেল গেটওয়ে সেটিং আপডেট করতে, গেটওয়ে ফিড URL-এ একটি HTTP PUT অনুরোধ পাঠান: 

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

PUT অনুরোধের XML হলো: 

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</atom:entry>

অনুরোধের বৈশিষ্ট্যগুলো হলো:

স্মার্টহোস্ট
আপনার SMTP সার্ভারের আইপি অ্যাড্রেস অথবা হোস্টনেম। গুগল ওয়ার্কস্পেস বহির্গামী মেইল ​​এই সার্ভারে পাঠায়।
smtpMode
ডিফল্ট মান হলো SMTP। আরেকটি মান, SMTP_TLS, বার্তা প্রেরণের সময় TLS ব্যবহার করে সংযোগটিকে সুরক্ষিত করে।

একটি সফল প্রতিক্রিয়ার ফলে HTTP 200 OK স্ট্যাটাস কোডের সাথে ইমেল গেটওয়ে সেটিংসের স্ট্যাটাসসহ AtomPub ফিডটি ফেরত আসে।

যদি কোনো কারণে আপনার অনুরোধ ব্যর্থ হয়, তাহলে একটি ভিন্ন স্ট্যাটাস কোড ফেরত দেওয়া হয়। গুগল ডেটা এপিআই স্ট্যাটাস কোড সম্পর্কে আরও তথ্যের জন্য, HTTP স্ট্যাটাস কোড দেখুন।

ইমেল রাউটিং সেটিংস পরিচালনা করুন

প্রথমে, একটি XML অনুরোধ তৈরি করুন: 

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='routeDestination' value='route-smtp.domain.com'/>
<apps:property name='routeRewriteTo' value='true'/>
<apps:property name='routeEnabled' value='true'/>
<apps:property name='bounceNotifications' value='true'/>
<apps:property name='accountHandling' value='can be either allAccounts | provisionedAccounts | unknownAccounts'/>
</atom:entry>

অনুরোধের বৈশিষ্ট্যগুলো হলো:

রুট গন্তব্য
এই গন্তব্যটি হলো SMTP-In মেইল ​​সার্ভারের হোস্টনেম বা আইপি অ্যাড্রেস, যেখানে ইমেলটি রাউট করা হচ্ছে। হোস্টনেম বা আইপি অ্যাড্রেসটি অবশ্যই গুগলের জন্য রিজলভযোগ্য হতে হবে। মেইল ​​হোস্টনেম রিজলভ করার বিষয়ে আরও বিস্তারিত জানতে, “Pilot Google Workspace with email routing ” দেখুন।
routeRewriteTo
যদি 'true' হয়, তাহলে মেসেজের SMTP এনভেলপের ' to: ' ফিল্ডটি গন্তব্যের হোস্টনেমে (user@destination's hostname) পরিবর্তন করা হয় এবং মেসেজটি গন্তব্য মেইল ​​সার্ভারে এই ব্যবহারকারীর ঠিকানায় পৌঁছে দেওয়া হয়। যদি false , তাহলে ইমেলটি গন্তব্য মেইল ​​সার্ভারে মূল মেসেজের ' to: ' ইমেল ঠিকানায় (user@original hostname) পৌঁছে দেওয়া হয়। এটি অ্যাডমিন কনসোলের 'Change SMTP envelope' সেটিংয়ের অনুরূপ। আরও তথ্যের জন্য, 'Domain settings for email routing ' দেখুন।
রুট সক্ষম করা হয়েছে
যদি true , তাহলে ইমেল রাউটিং কার্যকারিতা সক্রিয় থাকে। যদি false , তাহলে কার্যকারিতাটি নিষ্ক্রিয় থাকে।
বাউন্স নোটিফিকেশন
যদি true , তাহলে কোনো ডেলিভারি ব্যর্থ হলে Google Workspace প্রেরককে বাউন্স নোটিফিকেশন পাঠাতে সক্ষম হবে।
অ্যাকাউন্ট পরিচালনা
এই সেটিংটি নির্ধারণ করে যে ডোমেইনের বিভিন্ন ধরণের ব্যবহারকারী ইমেল রাউটিং দ্বারা কীভাবে প্রভাবিত হবেন:
  • allAccounts -- সমস্ত ইমেল এই ঠিকানায় পৌঁছে দিন।
  • provisionedAccounts -- যদি ব্যবহারকারী Google Workspace-এ বিদ্যমান থাকেন, তবে এই গন্তব্যে মেইল ​​প্রেরণ করুন।
  • unknownAccounts -- যদি ব্যবহারকারী Google Workspace-এ না থাকেন, তাহলে এই গন্তব্যে মেইল ​​ডেলিভার করুন। এটি অ্যাডমিন কনসোলের 'Delivery email for' সেটিং-এর অনুরূপ। পূর্বশর্ত এবং মেইল ​​রাউটিং কীভাবে ব্যবহার করতে হয় সে সম্পর্কে আরও তথ্যের জন্য, ' Domain settings for email routing ' দেখুন।

এই অনুরোধটি প্রকাশ করতে, ইমেল রাউটিং ফিড URL-এ একটি HTTP POST পাঠান এবং 'অ্যাডমিন সেটিংস পরিষেবাতে প্রমাণীকরণ' অংশে বর্ণিত পদ্ধতি অনুযায়ী একটি Authorization হেডার অন্তর্ভুক্ত করুন। 

    https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/emailrouting

একটি সফল প্রতিক্রিয়ার ফলে একটি HTTP 200 OK স্ট্যাটাস কোড এবং আর্কাইভের তথ্যসহ একটি AtomPub ফিড ফেরত আসে।

যদি কোনো কারণে আপনার অনুরোধ ব্যর্থ হয়, তাহলে একটি ভিন্ন স্ট্যাটাস কোড ফেরত দেওয়া হয়। গুগল ডেটা এপিআই স্ট্যাটাস কোড সম্পর্কে আরও তথ্যের জন্য, HTTP স্ট্যাটাস কোড দেখুন।

এন্ডপয়েন্টগুলো ৩১ অক্টোবর, ২০১৮ তারিখে বন্ধ হয়ে গেছে।

এই ঘোষণার অংশ হিসেবে আমরা নিম্নলিখিত এন্ডপয়েন্টগুলো বাতিল করেছি। এগুলো ৩১ অক্টোবর, ২০১৮ তারিখে বন্ধ করে দেওয়া হয়েছে এবং এখন আর উপলব্ধ নেই।

  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/defaultLanguage
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/organizationName
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/currentNumberOfUsers
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/maximumNumberOfUsers
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/supportPIN
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/customerPIN
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/adminSecondaryEmail
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/edition
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/creationTime
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/countryCode
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/appearance/customLogo
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/verification/mx