Cato SCIM API ব্যবহারের মাধ্যমে কাস্টম SCIM অ্যাপস

এই প্রবন্ধে বর্ণনা করা হয়েছে কীভাবে Cato এর SCIM API ব্যবহার করে এক পরিচয় প্রদানকারী (IdP) এর সাথে ব্যবহারকারী এবং ব্যবহারকারী গ্রুপ প্রদানে করা যায়।

IdP ভাড়াটিয়ার কাস্টম SCIM অ্যাপ সম্পর্কে আরও তথ্যের জন্য, IdP এর জন্য একটি কাস্টম SCIM অ্যাপ তৈরি করা দেখুন।

কাস্টম ক্যাটো SCIM অ্যাপ

আপনার Cato অ্যাকাউন্টে ব্যবহারকারী এবং ব্যবহারকারী গ্রুপ প্রদানে কাস্টম SCIM অ্যাপ ব্যবহার করতে, Cato Management Application (CMA) এ অ্যাপ তৈরি করুন। অতিরিক্ত হিসেবে, আপনাকে আপনার IdP এর জন্য Cato SCIM গুণাবলী গুণাবলীতে মানচিত্র করতে হবে।

CMA তে একটি কাস্টম SCIM অ্যাপ তৈরি করুন

SCIM API ব্যবহার করতে, প্রথমে CMA তে একটি কাস্টম এসসিআইএম অ্যাপ তৈরি করতে হবে। এই অ্যাপটি আপনাকে আপনার আইডেন্টিটি প্রোভাইডার (IdP) কেটো প্ল্যাটফর্মের সাথে সমন্বিত করতে দেয়।

CMA তে একটি কাস্টম SCIM অ্যাপ তৈরি করতে:

1. নেভিগেশন মেনু থেকে, আ্যাক্সেস > ডিরেক্টরি সেবাসমূহ নির্বাচন করুন।

2. SCIM ট্যাবের অধীনে, নতুন।

3. অ্যাপটির জন্য একটি নাম প্রবেশ করান।

4. প্রদানকারী এর অধীনে, কাস্টম নির্বাচন করুন।

5. টোকেন তৈরি করুন এ ক্লিক করুন এবং মানটি কপি করুন; আপনি যখন সংরক্ষণ করবেন তখন এটি আর উপলব্ধ থাকবে না এবং আপনাকে একটি নতুন টোকেন তৈরি করতে হবে। 

6. সংরক্ষণ করুন চাপ দিন।

7. নীচে বর্ণিত SCIM API এন্ডপয়েন্টগুলো কল করার সময়, আপনাকে প্রমাণীকরণের জন্য নিম্নলিখিত মানগুলির প্রয়োজন হবে:

   • এসসিআইএম বেস ইউআরএল: এপিআই অনুরোধের জন্য বেস পাথ হিসাবে ব্যবহৃত হয়

   • বেয়ারার টোকেন: এপিআই অনুরোধ যাচাইকরণের জন্য ব্যবহৃত হয়

Cato SCIM গুণাবলী

এটি Cato ব্যবহারকারী এবং ব্যবহারকারী গ্রুপের জন্য SCIM গুণাবলী যা আপনাকে IdP গুণাবলীতে মানচিত্র করতে হবে।

Cato SCIM API বোঝা

Cato SCIM API তে প্রমাণীকরণ করা

ক্লায়েন্টেরা RFC 6750 দ্বারা সংজ্ঞায়িত হওয়া অনুযায়ী SCIM API তে বিয়ারার টোকেন প্রমাণীকরণের মাধ্যমে প্রমাণীকৃত হয়। সমস্ত API অনুরোধে নিম্নলিখিত HTTP হেডার থাকতে হবে:

Authorization: Bearer <access_token>
Content-Type: application/json

আপনি Cato Management Application থেকে এক্সেস টোকেন পেতে পারেন।

SCIM এন্ডপয়েন্টগুলির জন্য ভিত্তি পথ

সমস্ত SCIM API এন্ডপয়েন্টগুলি নিম্নলিখিত ভিত্তি পথ ব্যবহার করে:

/scim/v2/{accountId}/{sourceId}

পথ পরামিতিগুলি: 

• accountId (string): আপনার Cato টেনেন্ট অ্যাকাউন্টের অনন্য শনাক্তকারী

• sourceId (integer): একটি নির্দিষ্ট IdP সংহতিকে প্রতিনিধিত্ব করতে Cato দ্বারা নির্ধারিত শনাক্তকারী

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

ব্যবহারকারীদের পরিচালনা করা

এই অধ্যায়ে Cato SCIM API ব্যবহার করে SCIM ব্যবহারকারী এনটিটি তৈরি, আপডেট, মুছে ফেলা এবং পুনরুদ্ধার করার পদ্ধতি বর্ণনা করা হয়েছে।

একটি ব্যবহারকারী তৈরি করুন

এইচটিটিপি পদ্ধতি:POST /Users 

প্রয়োজনীয় ক্ষেত্রগুলি: 

• userName (string): অনন্য ব্যবহারকারী নাম (উদাহরণস্বরূপ, ইমেল ঠিকানা)

• externalId (string): IdP থেকে বাহ্যিক শনাক্তকারী

• active (boolean): ব্যবহারকারী সক্রিয় করতে true হতে হবে

দ্রষ্টব্য:id SCIM সেবা দ্বারা ফেরত দেওয়া হয় এবং পরবর্তী API কলগুলিতে ব্যবহার করতে হবে। externalId ঐচ্ছিক এবং API পথে ব্যবহার করা যাবে না।

প্রতিক্রিয়া: 

• অবস্থা: 201 তৈরি

ত্রুটি: 

• 400 Bad Request: অবৈধ স্কীমা

• 401 Unauthorized 

• 409 Conflect: ডুপ্লিকেট userName অথবা externalId

একজন ব্যবহারকারী আপডেট করুন

PUT

এইচটিটিপি পদ্ধতি:PUT /Users/{id} 

প্রয়োজনীয় ক্ষেত্র: 

• id: Cato থেকে অভ্যন্তরীণ SCIM ID

প্রতিক্রিয়া: 

• স্ট্যাটাস: 200 OK

ত্রুটি: 

• 401 Unauthorized 

• 404 Not Found 

• 409 Conflect: ডুপ্লিকেট userName অথবা externalId

PATCH

এইচটিটিপি পদ্ধতি:PATCH /Users/{id} 

প্রতিক্রিয়া: 

• স্ট্যাটাস: 200 OK

ত্রুটি: 

• 400 খারাপ অনুরোধ: অবৈধ স্কিমা বা প্যাচ সিনট্যাক্স

• 401 Unauthorized 

• 404 Not Found 

• 409 Conflect: ডুপ্লিকেট শনাক্তকারী

একজন ব্যবহারকারী মুছে ফেলুন

HTTP পদ্ধতি:DELETE /Users/{id}

প্রতিক্রিয়া:

• অবস্থা: 204 কোন বিষয়বস্তু নেই

এটি একটি নরম মোছা। ব্যবহারকারী সিস্টেমে থাকে কিন্তু অনুসন্ধানে ফিরিয়ে দেওয়া হয় না।

ID দ্বারা একজন ব্যবহারকারী পান

HTTP পদ্ধতি:GET /Users/{id}

প্রতিক্রিয়া:

• স্ট্যাটাস: 200 OK

ত্রুটি:

• 401 Unauthorized

• 404 Not Found

ব্যবহারকারী অনুসন্ধান করুন

HTTP পদ্ধতি:GET /Users

অনুসন্ধান প্যারামিটার:

• filter: ব্যবহারকারীদের ফিল্টার করার জন্য প্রশ্ন (উদাহরণস্বরূপ, userName eq "user@domain.com")

• count (বিকল্প)

• startIndex (বিকল্প)

সমর্থিত ফিল্টারগুলি:

• শুধু eq সমর্থিত

• সমর্থিত গুণাবলী: userName, email, givenName, familyName

• সম্পূরক ফিল্টারগুলি শুধুমাত্র এই ফরম্যাটে সমর্থিত:

  filter=emails[type eq "work"] এবং email eq "bob@cato.com"

প্রতিক্রিয়া:

• স্ট্যাটাস: 200 OK

ত্রুটি:

• 401 Unauthorized

গোষ্ঠীসমূহ পরিচালনা

এই বিভাগটি ব্যাখ্যা করে কিভাবে আপনার Cato পরিবেশে গোষ্ঠী সত্ত্বা তৈরি, আপডেট, মুছে ফেলা, এবং পুনঃউদ্ধার করতে SCIM API ব্যবহার করবেন।

একটি গোষ্ঠী তৈরি করুন

HTTP পদ্ধতি:POST /Groups

প্রতিক্রিয়া:

• অবস্থা: 201 তৈরি

ত্রুটি:

• 401 Unauthorized

• 409 দ্বন্দ্ব: সদৃশ displayName অথবা অবজেক্ট ID

একটি গোষ্ঠী আপডেট করুন

PUT

HTTP পদ্ধতি:PUT /Groups/{id}

প্রতিক্রিয়া:

• স্ট্যাটাস: 200 OK

ত্রুটি:

• 401 Unauthorized

• 404 Not Found

• 409 দ্বন্দ্ব

PATCH

HTTP পদ্ধতি:PATCH /Groups/{id}

সমর্থিত প্যাচ পথ:

• প্রদর্শনের নাম

• সদস্য

প্রতিক্রিয়া:

• স্ট্যাটাস: 200 OK

ত্রুটি:

• 400 খারাপ অনুরোধ: অবৈধ স্কিমা বা প্যাচ সিনট্যাক্স

• 401 Unauthorized

• 404 Not Found

• 409 দ্বন্দ্ব

একটি গোষ্ঠী মুছে ফেলুন

HTTP পদ্ধতি:DELETE /Groups/{id}

প্রতিক্রিয়া:

• অবস্থা: 204 কোন বিষয়বস্তু নেই

গুরুত্বপূর্ণ:

এটি একটি শক্ত মোছা। গোষ্ঠীটি স্থায়ীভাবে সরানো হয়।

ID দ্বারা একটি গোষ্ঠী পান

HTTP পদ্ধতি:GET /Groups/{id}

বিকল্প অনুসন্ধান প্যারামিটার:

• excludeAttributes (যেমন members)

প্রতিক্রিয়া:

• স্ট্যাটাস: 200 OK

ত্রুটি:

• 401 Unauthorized

• 404 Not Found

গোষ্ঠীসমূহ খুঁজুন

HTTP পদ্ধতি:GET /Groups

অনুসন্ধান প্যারামিটার:

• filter: শুধুমাত্র displayName eq "Group Name" সমর্থিত

• count (বিকল্প)

• startIndex (বিকল্প)

যৌগিক ফিল্টার বা অসমর্থিত অপারেটরগুলি সকল গোষ্ঠী পুনঃআনয়ন করবে যা ফিল্টার করার প্রয়োজন নেই।

প্রতিক্রিয়া:

• স্ট্যাটাস: 200 OK

ত্রুটি:

• 401 Unauthorized

নোটসমূহ

তৈরিতে id ক্ষেত্রের আচরণ

• ব্যবহারকারী এবং গোষ্ঠী তৈরির অনুরোধে id ক্ষেত্র ঐচ্ছিক।

• যদি ফেলে দেওয়া হয়, SCIM পরিষেবা একটি অনন্য id তৈরি করে।

• পরবর্তী API কলগুলোতে সর্বদা প্রাপ্ত id মান ব্যবহার করুন।

গুরুত্বপূর্ণ:

প্রয়োজন না হলে ক্লায়েন্ট-উৎপন্ন আইডি ব্যবহার এড়িয়ে চলুন। SCIM id হল প্রামাণিক শনাক্তকারী।

মুছে ফেলা আচরণ

• ব্যবহারকারী মুছে ফেলা DELETE /Users/{id} এর মাধ্যমে একটি নরম মুছে ফেলা সম্পাদন করে active ক্ষেত্রকে false করে। GET /Users/{id} এর মাধ্যমে ব্যবহারকারী পুনঃউদ্ধারযোগ্য কিন্তু GET /Users ফলাফলে অন্তর্ভুক্ত নয়।

• গোষ্ঠী মুছে ফেলা DELETE /Groups/{id} এর মাধ্যমে একটি কঠিন মুছে ফেলা সম্পাদন করে। গোষ্ঠীটি স্থায়ীভাবে সরানো হয়।