onefuzz/docs/AADEntitites.md
Noah McGregor Harper f02f3f0ae2
Updating AAD Docs and UserAssignment Roel Description. (#1581)
* Updating doc and role description.

* Update src/deployment/deploy.py

Co-authored-by: Cheick Keita <kcheick@gmail.com>

* Update docs/AADEntitites.md

Co-authored-by: Cheick Keita <kcheick@gmail.com>

Co-authored-by: nharper285 <nharper285@gmail.com>
Co-authored-by: Cheick Keita <kcheick@gmail.com>
2022-01-14 10:02:14 -08:00

2.1 KiB

Azure Active Directory Entities

This document describes the configuration of entities create in Azure AD by our deployment script

OneFuzz Application Registration

This is the registration of the OneFuzz instance.

  • name : <instance_name>
  • app roles
    • ManagedNode
      • value: ManagedNode
      • Allowed Member types: Applications
    • CliClient
      • value: CliClient
      • Allowed Member types: Applications
    • UserAssignment
      • value: UserAssignment
      • Allowed Member types: Users/Groups
  • API Permissions
  • scope
    • user_impersonation
  • Authorized application:
    • OneFuzz CLI registration
  • Properties:
    • Assignment required?: Yes

OneFuzz Application Service Principal

Service principal linked to the OneFuzz application registration.

  • name: <instance_name>
  • Application Id: <OneFuzz Application registration app_id>

OneFuzz CLI registration

The registration for the command line interface.

  • name: <instance_name>-cli

OneFuzz CLI Service Principal

Service principal linked to the OneFuzz CLI application registration.

  • name: <instance_name>-cli
  • Application Id: <OneFuzz CLI registration app_id>
  • User Assignment required: true
  • Permission
    • CliClient (from OneFuzz Application registration)

Managed Node Service Principal

This entity is available after the first deployment. This is the service principal associated with the user-assigned managed identity <instance_name>-scalesetid.

  • name: <instance_name>-scalesetid
  • Service Principal
    • Permission
      • ManagedNode (from OneFuzz Application registration)

Deployment Service Principal

This entity is the 'user' service principal that invokes a OneFuzz deployment. This service principal is assigned access to the instance's primary App Registration.

  • name: <user_name_sp>
  • Service Principal
    • Permission
      • UserAssignment (from OneFuzz Application registration)