Skip to content

Commit a495e65

Browse files
Fix Principal spelling and update CCM managed challenge instructions
1 parent 51e83de commit a495e65

File tree

4 files changed

+14
-13
lines changed

4 files changed

+14
-13
lines changed

docs/dns/providers/azuredns.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ _Azure DNS documentation originally written by: Tony Johncock @Tony1044_
99

1010
# To Configure using Azure Portal
1111

12-
## Create an Azure AD Service Principle
12+
## Create an Azure AD Service Principal
1313

1414
- In Azure Active Directory, create a user who will then be assigned permissions to update your DNS zone, this can be an App registration. **Take note of your Application (client) ID and Directory (tenant) ID.**
1515
- In your DNS Zone, use the Access Control (IAM) option to Add a Role Assignment (DNS Zone Contributor). **Take note of your DNS Zone resource-group name and Subscription ID**

docs/hub/guides/ccm.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -67,25 +67,25 @@ The hub does not currently have global settings that can be pushed to all manage
6767

6868
If you manage instances across different organizations (e.g. if you are an MSP etc), consider creating multiple joining keys to partition by organization. This allows you to revoke hub access for specific groups without affecting unrelated instances.
6969

70-
### 1. Add a Security Principle for Managed Instances
70+
### 1. Add a Security Principal for Managed Instances
7171

7272
This step may be unnecessary in current versions where it's auto-created.
7373

7474
1. In the hub, navigate to **Security > Users**
75-
2. Click **Add New Security Principle**
75+
2. Click **Add New Security Principal**
7676
3. Configure as follows:
7777
- **Type**: Application/Service
7878
- **Title**: "Hub Managed Instance"
79-
- **Description**: "Principle for Management Hub Instance Joining"
80-
4. After adding, click the **Roles icon** (People+ icon) next to the new security principle's ID
79+
- **Description**: "Principal for Management Hub Instance Joining"
80+
4. After adding, click the **Roles icon** (People+ icon) next to the new security principal's ID
8181
5. Select the `Management Hub Managed Instance` role from Available Roles
8282
6. Click **Save**
8383

8484
### 2. Create an API Key for Joining Instances
8585

8686
1. Navigate to **Settings > Security > API Access**
8787
2. Click **Add API Token**
88-
3. Select **Managed Instances Service Principle**
88+
3. Select **Managed Instances Service Principal**
8989
4. Enter **Instance Joining Key** as the title
9090
5. Select **Management Hub Managed Instance** as the scoped role
9191
- **Important:** Click **Add/Remove Role Scope** to add it to the scope list

docs/hub/guides/managedchallenges.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,27 +29,27 @@ Under *Services > Managed Challenges*, select `+ Add`:
2929
- Populate the *Domain Match Rule* to specify the domains this configuration can update DNS for, then Save.
3030

3131
### 2. Configure API Access
32-
Before you can use your managed challenge you need to configure API access. This involves assigning an API token for a specific *Service Principle* (a specific user or app).
32+
Before you can use your managed challenge you need to configure API access. This involves assigning an API token for a specific *Service Principal* (a specific user or app).
3333

3434
Under *Settings > Security > Users*, add a User to represent the consumer (user or app etc) accessing the service, then assign them the Managed Challenge Consumer Role. They can have any other roles they need, but you'll need this specific role to access managed challenges.
3535

36-
Under *Settings > Security > API Access*, select Add API Token, select the required security principle, enter a descriptive title etc for this consumer token so you know why it exists and what it's being used for. To scope the API access token to managed challenges only, select Managed Challenge Consumer from the Role list and click Add/Remove Role Scope, then Save. A new API token will be created and you will need the Client ID and Secret values to access the API and use the managed challenge.
36+
Under *Settings > Security > API Access*, select Add API Token, select the required security principal, enter a descriptive title etc for this consumer token so you know why it exists and what it's being used for. To scope the API access token to managed challenges only, select Managed Challenge Consumer from the Role list and click Add/Remove Role Scope, then Save. A new API token will be created and you will need the Client ID and Secret values to access the API and use the managed challenge.
3737

3838
1. In the hub, navigate to **Settings > Security > Users**
3939
2. Click **Add User**
4040
3. Configure as follows:
4141
- **Type**: Application/Service
4242
- **Title**: "Managed Challenge User" (for example, to help identify the consumer of the managed challenge)
4343
- **Description**: "Managed challenge consumer" (for example)
44-
4. After adding, click the **Roles icon** (People+ icon) next to the new security principle's ID
44+
4. After adding, click the **Roles icon** (People+ icon) next to the new security principal's ID
4545
5. Select the `Managed Challenge Consumer` role from Available Roles to assign it.
4646
6. Click **Save**
4747

4848
### 3. Create an API Key to use the managed challenge
4949

5050
1. Navigate to **Settings > Security > API Access**
5151
2. Click **Add API Token**
52-
3. Select **Managed Challenge User** as the security principle.
52+
3. Select **Managed Challenge User** as the security principal.
5353
4. Enter **Managed Challenge API Key** as the title
5454
5. Select **Managed Challenge Consumer** as the scoped role
5555
- **Important:** Click **Add/Remove Role Scope** to add it to the scope list
@@ -59,10 +59,11 @@ Under *Settings > Security > API Access*, select Add API Token, select the requi
5959
#### Combined Hub joining and Managed Challenge Key
6060
It is possible to create a combined hub joining key and managed challenge key, which certain clients (such as Certify Certificate Manager) can use by default if they already know the hub joining key. This is provided as an option for convenience but is not configured by default.
6161

62-
To enable this, add the Managed Challenge Consumer role to the managed instance service principle (or a new service principle), then create a new hub joining key with both the *Hub Managed Instance* role and *Managed Challenge Consumer* role scope.
62+
To enable this, add the Managed Challenge Consumer role to the managed instance service principal (or a new service principal), then create a new hub joining key with both the *Hub Managed Instance* role and *Managed Challenge Consumer* role scope.
6363

6464
### Configure your ACME Client
6565
Where an ACME client supports Certify Managed Challenges you will follow the normal process used by that client for selecting that provider and you will be required to specify the Client ID and Secret from the above configuration, you will also need to specify the Management Hub API Url. When you then perform your certificate order it will call the Management Hub API to complete the DNS updates required.
6666

67-
In Certify Certificate Manager, under Authorization, select dns-01 as the Challenge Type, and Certify Managed Challenge API as the provider, then add the required credentials.
67+
#### Using with Certify Certificate Manager
68+
In *Certify Certificate Manager*, under Authorization, select dns-01 as the Challenge Type, and *Certify Managed Challenge API* as the provider, then add/select the required managed challenge consumer credentials. If the instance is joined to the hub you can leave the hub API url blank.
6869

docs/hub/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The product is available to try out as an release candidate version (shortly to
1515
**All the core features of [Certify Certificate Manager](../intro.md), with a web based management UI and API.**
1616
- **Self-hosted, cross-platform including Linux, macOS or Windows.**
1717
- Optionally manage thousands of certs across hundreds of existing *Certify Certificate Manager* instances, or renew centrally, from a "single pane of glass" UI.
18-
- Multi-user role based access security for administration and consuming certificates, with support for app/service security principles and individual scoped API access
18+
- Multi-user role based access security for administration and consuming certificates, with support for app/service security principal and individual scoped API access
1919
- Optional single sign on with [OIDC support](./guides/oidc.md) via providers such as Azure Entra.
2020
- Distribute certs using optional installed agents, deployment tasks, or use the API to pull the latest cert using your own integrations.
2121
- Optional centralized DNS challenges compatible with most popular ACME clients, so that privileged DNS credentials do not need to be stored across individual ACME clients.

0 commit comments

Comments
 (0)