Skip to content

Commit

Permalink
Azure AD entities description (microsoft#896)
Browse files Browse the repository at this point in the history
Added a description of the configuration of azure AD entities

closes microsoft#875
  • Loading branch information
chkeita authored May 17, 2021
1 parent ecec227 commit 3c0f6f5
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/AADEntitites.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Azure Active Directory Entities
This document describes the configuration of entities create in Azure AD by our [deployment script](../src/deployment/deploy.py)

### 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: ManagedNode
* Allowed Member types: Applications
* API Permissions
* _User.Read_ ([Microsoft Graph](https://docs.microsoft.com/en-us/graph/permissions-reference#user-permissions))
* scope
* `user_impersonation`
* Authorized application:
* OneFuzz CLI registration

### 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>-<scaleset_id>`.

* name: `<instance_name>-<scaleset_id>`
* Service Principal
* Permission
* _ManagedNode_ (from OneFuzz Application registration)

0 comments on commit 3c0f6f5

Please sign in to comment.