Skip to content

Commit ddd74db

Browse files
Draft docs
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
1 parent 508480e commit ddd74db

3 files changed

Lines changed: 111 additions & 0 deletions

File tree

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
You can pre-create applications and application registrations on behalf of a developer or team using the {{site.konnect_short_name}} API.
2+
3+
1. Create a developer application by sending a `POST` request to the `/portals/{portalId}/applications` endpoint:
4+
{% capture create-application %}
5+
<!--vale off-->
6+
{% konnect_api_request %}
7+
url: /v3/portals/$DEV_PORTAL_ID/applications
8+
method: POST
9+
status_code: 201
10+
body:
11+
name: "KongAir Application"
12+
description: "A portal application provisioned for a developer by a Portal Admin."
13+
auth_strategy_id: "$AUTH_STRATEGY_ID"
14+
owner:
15+
id: "$DEVELOPER_ID"
16+
type: "developer"
17+
{% endkonnect_api_request %}
18+
<!--vale on-->
19+
{% endcapture %}
20+
{{create-application | indent: 3}}
21+
22+
1. Copy and export the application ID:
23+
```sh
24+
export APPLICATION_ID='YOUR APPLICATION ID'
25+
```
26+
27+
1. Create an application registration by sending a `POST` request to the `/portals/{portalId}/applications/{applicationId}/registrations` endpoint:
28+
{% capture create-application-registration %}
29+
<!--vale off-->
30+
{% konnect_api_request %}
31+
url: /v3/portals/$DEV_PORTAL_ID/applications/$APPLICATION_ID/registrations
32+
method: POST
33+
status_code: 201
34+
body:
35+
api_id: "$API_ID"
36+
status: "approved"
37+
{% endkonnect_api_request %}
38+
<!--vale on-->
39+
{% endcapture %}
40+
{{create-application-registration | indent: 3}}
41+
42+
{:.warning}
43+
> **DCR applications:**
44+
> If the application will be using a DCR provider with the given auth strategy, the request must specify `dcr_client_id`.
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
You can pre-create developer accounts to provision their team association and API access before they access the {{site.dev_portal}}.
2+
3+
1. To automatically create developers and send them an email to create a password, send a `POST` request to the ` /portals/{portalId}/developers` endpoint:
4+
{% capture create-dev %}
5+
<!--vale off-->
6+
{% konnect_api_request %}
7+
url: /v3/portals/$DEV_PORTAL_ID/developers
8+
method: POST
9+
status_code: 201
10+
body:
11+
full_name: "Raina Sovani"
12+
email: "raina.sovani@example.com"
13+
status: "approved"
14+
send_notification_email: true
15+
{% endkonnect_api_request %}
16+
<!--vale on-->
17+
{% endcapture %}
18+
{{create-dev | indent: 3}}
19+
20+
1. Copy and export the developer ID:
21+
```sh
22+
export DEVELOPER_ID='YOUR DEVELOPER ID'
23+
```
24+
25+
1. Add the developer to an existing team that has the correct roles for the APIs they need access to by sending a `POST` request to the [`/portals/{portalId}/teams/{teamId}/developers` endpoint](/api/konnect/portal-management/v3/#/operations/add-developer-to-portal-team):
26+
{% capture add-dev-to-team %}
27+
<!--vale off-->
28+
{% konnect_api_request %}
29+
url: /v3/portals/$DEV_PORTAL_ID/teams/$TEAM_ID/developers
30+
method: POST
31+
status_code: 201
32+
body:
33+
id: "$DEVELOPER_ID"
34+
{% endkonnect_api_request %}
35+
<!--vale on-->
36+
{% endcapture %}
37+
{{add-dev-to-team | indent: 3}}
38+
39+
{:.warning}
40+
> **Logging in to {{site.dev_portal}}s:**
41+
> * **SSO:** If a developer is created in a {{site.dev_portal}} with SSO configured, they must be able to use SSO to login if their email address is configured in the identity provider.
42+
> After they log in, they will automatically approved.
43+
> * **Basic auth:** If a developer is created in a {{site.dev_portal}} with basic auth configured, they must be able to set their password. This can be done one of two ways:
44+
> * `send_notification_email: true`: Developers can use the link in the email to set their password.
45+
> * `send_notification_email: true`: Developers can click **Forgot password** in the {{site.dev_portal}} UI to set a password.

app/_landing_pages/dev-portal/self-service.yaml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ metadata:
99
- authentication
1010
breadcrumbs:
1111
- /dev-portal/
12+
works_on:
13+
- konnect
1214

1315
rows:
1416

@@ -191,6 +193,26 @@ rows:
191193
192194
Applications and API keys are specific to a [geographic region](/konnect-platform/geos/).
193195
When you enable application registration by selecting an authentication strategy during publication, the resulting applications and API keys are tied to the developers and traffic in that region.
196+
- columns:
197+
- blocks:
198+
- type: structured_text
199+
config:
200+
header:
201+
text: "Automate developer creation"
202+
blocks:
203+
- type: text
204+
text: |
205+
{% include dev-portal/create-dev-api.md %}
206+
207+
- blocks:
208+
- type: structured_text
209+
config:
210+
header:
211+
text: "Automate app creation"
212+
blocks:
213+
- type: text
214+
text: |
215+
{% include dev-portal/create-app-api.md %}
194216
- header:
195217
type: h3
196218
text: "Share applications with a team"

0 commit comments

Comments
 (0)