> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# API द्वारा Didit प्रमाणीकरण सेट अप करें

> अपने कोड से Didit में साइन-इन तरीके, सेटिंग्स, ब्रांडिंग और सुरक्षा सक्षम करें, मालिक-स्वीकृत ग्रांट या प्रमाणीकरण-स्कोप्ड API कुंजी के साथ।

Didit Authentication आपको API के ज़रिए साइन-इन के तरीके सक्षम करने और अपने एप्लिकेशन की सेटिंग्स पढ़ने देता है। किसी स्वामी द्वारा स्वीकृत ग्रांट का उपयोग करें, या `authentication` स्कोप वाली किसी नामित API कुंजी का उपयोग करें।

> [!WARNING]
>
> Authentication नई सुविधा है। किसी तरीके को पहले सैंडबॉक्स एप्लिकेशन में सेट करें, फिर अपने लाइव एप्लिकेशन में इसे सेट करें।

नीचे की हर कॉल आपके एप्लिकेशन की Authentication प्रबंधन API पर जाती है। `MANAGEMENT_BASE` यह है:

```text theme={null}
https://apx.didit.me/auth/v2/organizations/{org_id}/applications/{application_id}/authentication/
```

इन्हीं रूट्स का वर्णन `openapi-authentication.json` में `Setup` टैग के अंतर्गत किया गया है, और सर्वर SDK इसी से जनरेट होते हैं।

## किस क्रेडेंशियल का उपयोग करें

तीनों में से कोई भी क्रेडेंशियल काम करता है, और हर एक उसके मालिक द्वारा स्वीकृत दायरे तक सीमित रहता है।

| क्रेडेंशियल | इस रूप में भेजा गया | यह क्या कर सकता है |
| - | - | - |
| `authentication` स्कोप वाली नामित API कुंजी | `x-api-key: <key>` | अपने एप्लिकेशन को कॉन्फ़िगर करता है और उसे पढ़ता है। `read` वाली कुंजी केवल सेटअप पढ़ सकती है; `write` उसे पढ़ और बदल सकती है। |
| `didit:management` के साथ मालिक द्वारा स्वीकृत ग्रांट | `Authorization: Bearer <access_token>` | सहमति के समय स्वीकृत संगठनों के एप्लिकेशन को कॉन्फ़िगर करता है, व्यक्ति की भूमिका के भीतर। |
| कंसोल सत्र | `Authorization: Bearer <console session token>` | व्यक्ति की संगठन सदस्यता और भूमिका के अनुसार सेटिंग्स पढ़ता या बदलता है। एंड-यूज़र व्यू के लिए भी कंसोल सत्र और उपयुक्त अनुमतियाँ आवश्यक हैं। |

इन क्रेडेंशियल्स को हर सेटअप रूट पर, अनुरोध जो भी माँगे, `403` के साथ अस्वीकार किया जाता है:

* एप्लिकेशन का **प्राथमिक सीक्रेट**।
* `POST /programmatic/login` से मिला टोकन, जो कंसोल के बजाय एप्लिकेशन के लिए जारी होता है।
* `authentication` स्कोप के बिना कोई कुंजी, जिसमें हर संसाधन के लिए उसके उच्चतम स्तर के साथ बनाई गई कुंजी भी शामिल है: उन्हें पूर्ण पहुँच के रूप में सूचीबद्ध किया जाता है, `scopes` खाली रहता है और इन रूटों पर स्वीकार नहीं किया जाता।
* किसी दूसरे एप्लिकेशन की कुंजी, केवल `didit:verification` वाला ग्रांट, और किसी दूसरे संगठन के लिए स्वीकृत ग्रांट।

बिना किसी क्रेडेंशियल वाला अनुरोध `401` लौटाता है। ग्रांट या कुंजी की अपनी सीमाएँ भी लागू रहती हैं: ग्रांट की सीमा उसके स्कोप, संगठनों और व्यक्ति की भूमिका से तय होती है, और कुंजी की सीमा उसके स्कोप, IP अनुमति सूची और समाप्ति से।

## पहुँच स्वीकृत करें

### नामित API कुंजी के साथ

[Business Console](https://business.didit.me) में **Developers -> API keys** खोलें और जिस एप्लिकेशन का सेटअप कर रहे हैं उसके लिए एक कुंजी बनाएँ। उसे `authentication` संसाधन पर **read** या **write** अनुमति दें: read सेटअप पढ़ने वाली हर कॉल (`GET`) को कवर करता है; write सेटअप बदलने वाली हर कॉल (`POST`, `PUT`, `PATCH`, `DELETE`) को कवर करता है और सेटअप को पढ़ता भी है। समाप्ति, IP अनुमति सूची और रोटेशन के लिए [API keys](https://docs.didit.me/hi/console/api-keys.md) देखें; कुंजी एक ही एप्लिकेशन से जुड़ी होती है और केवल उसी के लिए काम करती है।

### MCP कनेक्शन के माध्यम से

Didit MCP सर्वर से जुड़ा एजेंट उस अनुमति का उपयोग करता है जिसे उसके मालिक ने सहमति स्क्रीन पर स्वीकृत किया है, और उस ग्रांट में `didit:management` शामिल होता है। देखें [MCP प्रमाणीकरण](https://docs.didit.me/hi/integration/mcp/authentication.md#didit-में-लॉग-इन-करें)।

### बिना पासवर्ड वाले मालिक के लिए

डिवाइस-कोड ग्रांट ([RFC 8628](https://datatracker.ietf.org/doc/html/rfc8628)) उस मालिक को, जो Google, पासकी या ईमेल से भेजे गए कोड से साइन इन करता है, किसी भी ब्राउज़र से वही पहुँच स्वीकृत करने देता है, बिना पासवर्ड टाइप किए। देखें [ब्राउज़र के बिना साइन इन करें](https://docs.didit.me/hi/integration/mcp/authentication.md#ब्राउज़र-के-बिना-साइन-इन-करें-डिवाइस-कोड)।

## ईमेल कोड सक्षम करें

`PUT methods/{name}/` के लिए `enabled` लिया जाता है, और जिस विधि को क्रेडेंशियल की ज़रूरत नहीं होती, उसके लिए इसके अलावा कुछ नहीं।

```bash theme={null}
curl --fail-with-body --request PUT "${MANAGEMENT_BASE}methods/code/" \
  -H "x-api-key: $DIDIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled": true}'
```

यह विधि की वर्तमान स्थिति का उत्तर देता है:

```json theme={null}
{"name": "code", "enabled": true}
```

जब आप कॉन्फ़िगरेशन वापस पढ़ते हैं, तो ईमेल कोड की प्रविष्टि में `credential_source: null` शामिल होता है। जो विधियाँ हमेशा चालू रहती हैं उन्हें बंद नहीं किया जा सकता: ऐसे अनुरोध का उत्तर `{"enabled": "always_on"}` होता है।

## Google सक्षम करें

सोशल मेथड के लिए आप अपने OAuth ऐप के क्रेडेंशियल दे सकते हैं, या किसी सैंडबॉक्स एप्लिकेशन पर Didit का टेस्ट ऐप इस्तेमाल कर सकते हैं।

### अपने Google ऐप के साथ

```bash theme={null}
curl --fail-with-body --request PUT "${MANAGEMENT_BASE}methods/google/" \
  -H "x-api-key: $DIDIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled": true, "credentials": {"client_id": "1234.apps.googleusercontent.com", "client_secret": "GOCSPX-..."}}'
```

रिस्पॉन्स में मिला `callback_uri` अपने प्रोवाइडर पर रजिस्टर करें। सीक्रेट केवल-लिखने योग्य है: कोई भी रिस्पॉन्स उसे वापस नहीं देता, और `client_id` ही वह हिस्सा है जिसे आप वापस पढ़ सकते हैं। अगर पहले कोई क्रेडेंशियल सहेजे नहीं गए थे, तो बिना क्रेडेंशियल के कोई मेथड चालू करने पर `{"credentials": "required"}` जवाब आता है।

### Didit के टेस्ट ऐप (`didit_test`) के साथ

एक **सैंडबॉक्स एप्लिकेशन** आपके ऐप की जगह Didit के अपने सोशल ऐप इस्तेमाल कर सकता है। सेटअप पूरा करने और उसे काम करता हुआ साबित करने के लिए यह पर्याप्त है:

```bash theme={null}
curl --fail-with-body --request PUT "${MANAGEMENT_BASE}methods/google/" \
  -H "x-api-key: $DIDIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled": true, "credential_source": "didit_test"}'
```

`didit_test` **Google, Microsoft, Apple और GitHub** को कवर करता है, और यह केवल सैंडबॉक्स एप्लिकेशन पर उपलब्ध है:

| उत्तर | कब |
| - | - |
| `{"credential_source": "sandbox_only"}` | एप्लिकेशन लाइव है। टेस्ट ऐप कभी लाइव साइन-इन सर्व नहीं करते। |
| `{"credential_source": "unavailable"}` | इस डिप्लॉयमेंट में उस प्रोवाइडर के लिए कोई टेस्ट ऐप नहीं है, इसलिए वह मेथड बंद रहता है। |
| `configured: true` के साथ `200` | टेस्ट ऐप वह मेथड सर्व करता है, और होस्टेड साइन-इन उसे ऑफ़र करता है। |

कॉन्फ़िगरेशन पर `GET` करने पर `didit_test_credentials` में वे प्रोवाइडर दिखते हैं जिन्हें इस एप्लिकेशन के लिए टेस्ट ऐप सर्व कर सकता है। लाइव एप्लिकेशन पर इन चारों के लिए यह मान `false` होता है।

## सेटअप को फिर से पढ़ें

`MANAGEMENT_BASE` पर `GET` ही रीड-बैक है: इसमें हर विधि के `enabled` और `credential_source` के साथ कॉलबैक URL, सत्र नियम और साइन-अप नीति मिलती है।

```bash theme={null}
curl --fail-with-body "$MANAGEMENT_BASE" -H "x-api-key: $DIDIT_API_KEY"
```

```json theme={null}
{
  "enabled": true,
  "methods": [
    {"name": "code", "enabled": true, "credential_source": null},
    {"name": "google", "enabled": true, "credential_source": "didit_test", "configured": true, "client_id": "didit-test-google"},
    {"name": "password", "enabled": false, "credential_source": null}
  ],
  "didit_test_credentials": {"google": true, "microsoft": true, "apple": true, "github": true},
  "redirect_uris": ["https://app.example.com/auth/callback"]
}
```

अक्षम विधियाँ भी सूची में दिखती हैं, इसलिए एक `GET` से पता चल जाता है कि कौन-सी चालू है और कौन-सी नहीं। जब एप्लिकेशन के लिए Authentication अक्षम होता है, तब सबसे ऊपर `enabled` का मान `false` होता है। किसी मैनेजमेंट ग्रांट या नामित कुंजी से की गई किसी भी सेटअप बदलाव की कोशिश पर `409` मिलता है, जिसके साथ `{"detail": "product_disabled"}` लौटता है, और कुछ भी लिखा नहीं जाता। कोई भी सेटअप कॉल Authentication चालू नहीं करती: यह काम कोई व्यक्ति कंसोल में एप्लिकेशन के लिए करता है, और उसके बाद आपकी कॉल काम करने लगती हैं।

## बाकी सेटअप

| `MANAGEMENT_BASE` के अंतर्गत रूट | मेथड | इसमें क्या है |
| - | - | - |
| `settings/` | `GET`, `PATCH` | एजेंट एक्सेस, संगठन, MFA नीति, डिफ़ॉल्ट सदस्य भूमिका, अक्षम किए गए webhook इवेंट |
| `onboarding/` | `GET`, `PATCH` | कौन से सेटअप चरण पूरे हुए हैं, और लोग होस्टेड पेज पर साइन इन करते हैं या आपकी अपनी स्क्रीन पर |
| `branding/` | `GET`, `PATCH` | होस्टेड पेज के टेक्स्ट और कानूनी लिंक (लोगो और रंग कस्टमाइज़ेशन से आते हैं) |
| `protection/` | `GET`, `PATCH` | बॉट सुरक्षा नीतियाँ ([बॉट सुरक्षा](https://docs.didit.me/hi/authentication/bot-protection.md)) |
| `verified/` | `GET`, `PATCH` | साइन-अप सत्यापन स्तर, स्टेप-अप नियम और token क्लेम |
| `emails/`, `emails/{key}/` | `GET` | वे साइन-इन ईमेल जो यह एप्लिकेशन भेजता है, और उनका रेंडर किया हुआ पूर्वावलोकन |
| `domain/` | `GET`, `PUT`, `DELETE` | होस्टेड ओरिजिन और कस्टम साइन-इन डोमेन |
| `domain/verify/`, `domain/activate/` | `POST` | डोमेन का DNS और सर्टिफ़िकेट जाँचें, फिर उसे कैनोनिकल ओरिजिन बनाएँ |
| `native-apps/` | `GET`, `PUT` | iOS और Android ऐप्स जो एप्लिकेशन की पासकी साझा करते हैं |

कोई ग्रांट या API कुंजी सेटअप और उसके काउंटर पढ़ सकती है, लेकिन कभी एंड-यूज़र डेटा नहीं: `users/`, `sessions/`, `sign-ins/`, `overview/`, ग्राहक संगठन, भूमिकाएँ, इंपोर्ट, एजेंट सत्र और टेस्ट ईमेल के लिए अब भी कंसोल सत्र चाहिए।

`agent_humans_only` सेटिंग पूरे एप्लिकेशन पर लागू होती है। इसे केवल संगठन का स्वामी या एडमिन बदल सकता है। नामित कुंजी को `403 owner_or_admin_required` मिलता है। इस सेटिंग को चालू करने के लिए एक पंजीकृत पासकी भी आवश्यक है (`passkey_required`)।

## त्रुटियाँ

| उत्तर | अर्थ |
| - | - |
| `401` | कोई क्रेडेंशियल नहीं है। |
| `403` | ऐसी क्रेडेंशियल जो इस एप्लिकेशन को कॉन्फ़िगर नहीं कर सकती, या उसकी अपनी किसी सीमा का उल्लंघन: `ip_not_allowed`, समाप्त हो चुकी कुंजी, या लेखन रूट पर इस्तेमाल होने वाली केवल-पठन कुंजी। |
| `409 {"detail": "product_disabled"}` | एप्लिकेशन के लिए प्रमाणीकरण बंद है, इसलिए ग्रांट या कुंजी से किया गया सेटअप बदलाव अस्वीकार कर दिया जाता है। इसे कोई व्यक्ति कंसोल में चालू करता है। |
| `400 {"<field>": "<code>"}` | `sandbox_only`, `unavailable`, `not_supported`, `required`, `always_on`, `method_unavailable`, `unknown_field`। |
| `404` | अनुरोध किया गया संसाधन नहीं मिला। |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.