fleetdm / fleet

Open-source platform for IT, security, and infrastructure teams. (Linux, macOS, Chrome, Windows, cloud, data center)
https://fleetdm.com
Other
3.01k stars 418 forks source link

Create new `fleet/mdm/apple/setup` endpoint to support new user authentication property #11000

Closed lukeheath closed 1 year ago

lukeheath commented 1 year ago

Tasks

Roles

// TODO: confirm these role requirements

Role authorised
global admin yes
global maintainer yes
global observer no
global observer+ ???
team admin yes for specific team
team maintainer yes for specific team
team observer no
team observer ???

License

API spec

Endpoint:

PATCH /api/v1/fleet/mdm/apple/setup

Request Body:

{
   team_id: number, // "0" represents "No Team"
   enable_end_user_authentication: boolean
}

Responses:

Success

code: 200

MDM Not Configured:

code: 422

{
  "message": ??? // TODO: confirm
  "errors": [
    "name": ??? // TODO: confirm
    "reason":  ??? // TODO: confirm
  ]
}

License Error:

// TODO: pull out and link from somewhere else

code: 402

{
  "message":  "requires Fleet Premium license" // TODO: confirm
  "errors": [
    "name": ??? // TODO: confirm
    "reason": ??? // TODO: confirm  
  ]
}

Server Error

// TODO: pull out and link from somewhere else

code: 500

{
  "message":  ??? // TODO: confirm
  "errors": [
    "name": 
    "reason":  
  ]
}

Example

PATCH /api/v1/fleet/mdm/apple/setup

Request Body:

{
   team_id: 1
   enable_end_user_authentication: true
}

API Checklist

lukeheath commented 1 year ago

Hey team! Please add your planning poker estimate with Zenhub @gillespi314 @mna @roperzh

fleet-release commented 1 year ago

Apple setup soars, End user authentication, A glass city shines.