Skip to content

Commit c99477f

Browse files
authored
Merge pull request #224129 from csmulligan/csmulligan-exid-sssu-api-connector
[EXID] Content freshness update for self-service-sign-up-add-api-connector
2 parents 84e2c05 + 25b9721 commit c99477f

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed
Loading
12.6 KB
Loading

articles/active-directory/external-identities/self-service-sign-up-add-api-connector.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ services: active-directory
55
ms.service: active-directory
66
ms.subservice: B2B
77
ms.topic: article
8-
ms.date: 07/13/2021
8+
ms.date: 01/16/2023
99

1010
ms.author: mimart
1111
author: msmimart
@@ -30,13 +30,13 @@ To use an [API connector](api-connectors-overview.md), you first create the API
3030
3. In the left menu, select **External Identities**.
3131
4. Select **All API connectors**, and then select **New API connector**.
3232

33-
:::image type="content" source="media/self-service-sign-up-add-api-connector/api-connector-new.png" alt-text="Providing the basic configuration like target URL and display name for an API connector during the creation experience.":::
33+
:::image type="content" source="media/self-service-sign-up-add-api-connector/api-connector-new.png" alt-text="Screenshot of adding a new API connector to External Identities.":::
3434

3535
5. Provide a display name for the call. For example, **Check approval status**.
3636
6. Provide the **Endpoint URL** for the API call.
3737
7. Choose the **Authentication type** and configure the authentication information for calling your API. Learn how to [Secure your API Connector](self-service-sign-up-secure-api-connector.md).
3838

39-
:::image type="content" source="media/self-service-sign-up-add-api-connector/api-connector-config.png" alt-text="Providing authentication configuration for an API connector during the creation experience.":::
39+
:::image type="content" source="media/self-service-sign-up-add-api-connector/api-connector-config.png" alt-text="Screenshot of configuring an API connector.":::
4040

4141
8. Select **Save**.
4242

@@ -129,7 +129,7 @@ Content-type: application/json
129129
}
130130
```
131131

132-
The exact claims sent to the API depends on which information is provided by the identity provider. 'email' is always sent.
132+
The exact claims sent to the API depend on which information is provided by the identity provider. 'email' is always sent.
133133

134134
### Expected response types from the web API at this step
135135

@@ -187,7 +187,7 @@ Content-type: application/json
187187
"ui_locales":"en-US"
188188
}
189189
```
190-
The exact claims sent to the API depends on which information is collected from the user or is provided by the identity provider.
190+
The exact claims sent to the API depend on which information is collected from the user or is provided by the identity provider.
191191

192192
### Expected response types from the web API at this step
193193

@@ -212,7 +212,7 @@ A blocking response exits the user flow. It can be purposely issued by the API t
212212
See an example of a [blocking response](#example-of-a-blocking-response).
213213

214214
### Validation-error response
215-
When the API responds with a validation-error response, the user flow stays on the attribute collection page and a `userMessage` is displayed to the user. The user can then edit and resubmit the form. This type of response can be used for input validation.
215+
When the API responds with a validation-error response, the user flow stays on the attribute collection page, and a `userMessage` is displayed to the user. The user can then edit and resubmit the form. This type of response can be used for input validation.
216216

217217
See an example of a [validation-error response](#example-of-a-validation-error-response).
218218

@@ -237,7 +237,7 @@ Content-type: application/json
237237
| version | String | Yes | The version of your API. |
238238
| action | String | Yes | Value must be `Continue`. |
239239
| \<builtInUserAttribute> | \<attribute-type> | No | Values can be stored in the directory if they selected as a **Claim to receive** in the API connector configuration and **User attributes** for a user flow. Values can be returned in the token if selected as an **Application claim**. |
240-
| \<extension\_{extensions-app-id}\_CustomAttribute> | \<attribute-type> | No | The claim does not need to contain `_<extensions-app-id>_`, it is *optional*. Returned values can overwrite values collected from a user. |
240+
| \<extension\_{extensions-app-id}\_CustomAttribute> | \<attribute-type> | No | The claim doesn't need to contain `_<extensions-app-id>_`, it's *optional*. Returned values can overwrite values collected from a user. |
241241

242242
### Example of a blocking response
243243

@@ -248,7 +248,7 @@ Content-type: application/json
248248
{
249249
"version": "1.0.0",
250250
"action": "ShowBlockPage",
251-
"userMessage": "There was a problem with your request. You are not able to sign up at this time.",
251+
"userMessage": "There was an error with your request. Please try again or contact support.",
252252
}
253253
254254
```
@@ -305,7 +305,7 @@ Ensure that:
305305
* Your API implements an authentication method outlined in [secure your API Connector](self-service-sign-up-secure-api-connector.md).
306306
* Your API responds as quickly as possible to ensure a fluid user experience.
307307
* Azure AD will wait for a maximum of *20 seconds* to receive a response. If none is received, it will make *one more attempt (retry)* at calling your API.
308-
* If using a serverless function or scalable web service, use a hosting plan that keeps the API "awake" or "warm" in production. For Azure Functions, it's recommended to use at minimum the [Premium plan](../../azure-functions/functions-scale.md)
308+
* If using a serverless function or scalable web service, use a hosting plan that keeps the API "awake" or "warm" in production. For Azure Functions, it's recommended to use at minimum the [Premium plan](../../azure-functions/functions-scale.md#overview-of-plans)
309309
* Ensure high availability of your API.
310310
* Monitor and optimize performance of downstream APIs, databases, or other dependencies of your API.
311311
* Your endpoints must comply with the Azure AD TLS and cipher security requirements. For more information, see [TLS and cipher suite requirements](../../active-directory-b2c/https-cipher-tls-requirements.md).

0 commit comments

Comments
 (0)