Skip to content
This repository has been archived by the owner on Nov 1, 2023. It is now read-only.

App Roles for the App Registration should be documented #875

Closed
ryanspletzer opened this issue May 11, 2021 · 3 comments · Fixed by #896
Closed

App Roles for the App Registration should be documented #875

ryanspletzer opened this issue May 11, 2021 · 3 comments · Fixed by #896
Assignees

Comments

@ryanspletzer
Copy link

I had to dig through the python deployment script in order to understand the app roles that needed to be configured on the app registration.

app_roles = [
AppRole(
allowed_member_types=["Application"],
display_name=OnefuzzAppRole.CliClient.value,
id=str(uuid.uuid4()),
is_enabled=True,
description="Allows access from the CLI.",
value=OnefuzzAppRole.CliClient.value,
),
AppRole(
allowed_member_types=["Application"],
display_name=OnefuzzAppRole.ManagedNode.value,
id=str(uuid.uuid4()),
is_enabled=True,
description="Allow access from a lab machine.",
value=OnefuzzAppRole.ManagedNode.value,
),
]

Provide a description of requested docs changes

This should more clearly be delineated in markdown documentation in the event that someone is trying to create the app registration by hand. In most secure enterprises, people do not have standing access to create apps / service principals in Azure AD and there is typically a process for getting one created. In this event, in would be helpful to have this documented to save people time from trying to discern all the things the python deployment script is doing.

@shambho
The deployment script is the only supported way to register the application. We do not support the manual creation.
You are welcome to translate the deployment code to manual steps or wait for the audit of the deployment script.

Originally posted by @chkeita in #813 (comment)

A few lines of documentation on how to set up the app registration is a reasonable ask here.

@chkeita
Copy link
Contributor

chkeita commented May 13, 2021

That is good suggestion. We will add description of the azure entities created by the deployment script in the docs.

@ghost ghost closed this as completed in #896 May 17, 2021
ghost pushed a commit that referenced this issue May 17, 2021
Added a description of the configuration of azure AD entities

closes #875
@chkeita
Copy link
Contributor

chkeita commented May 17, 2021

docs updated

@ryanspletzer
Copy link
Author

@chkeita thank you so much!

@ghost ghost locked as resolved and limited conversation to collaborators Jun 19, 2021
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants