user and role

packages/spec/specs/components/role.yaml

@@ -1,43 +1,51 @@
 type: object
 properties:
-  collection_listing:
-    description: Custom override for the admin app collection navigation.
-    example: null
-    type: object
-    nullable: true
+  id:
+    description: Unique identifier for the role.
+    example: 2f24211d-d928-469a-aea3-3c8f53d4e426
+    type: string
+  name:
+    description: Name of the role.
+    example: Administrator
+    type: string
+  icon:
+    description: The role's icon.
+    example: verified_user
+    type: string
   description:
     description: Description of the role.
     example: Admins have access to all managed data within the system by default
     type: string
     nullable: true
-  enforce_tfa:
-    description: Whether or not this role enforces the use of 2FA.
-    example: false
-    type: boolean
-  external_id:
-    description: ID used with external services in SCIM.
-    example: null
-    type: string
-    nullable: true
-  id:
-    description: Unique identifier for the role.
-    example: 2f24211d-d928-469a-aea3-3c8f53d4e426
-    type: string
-  ip_whitelist:
-    description: Array of IP addresses that are allowed to connect to the API as a
+  ip_access:
+    description:
+      Array of IP addresses that are allowed to connect to the API as a
       user of this role.
     example: []
     type: array
     items:
       type: string
-  module_listing:
+  enforce_tfa:
+    description: Whether or not this role enforces the use of 2FA.
+    example: false
+    type: boolean
+  module_list:
     description: Custom override for the admin app module bar navigation.
     example: null
     type: array
     items:
       type: object
     nullable: true
-  name:
-    description: Name of the role.
-    example: Administrator
-    type: string
+  collection_list:
+    description: Custom override for the admin app collection navigation.
+    example: null
+    type: object
+    nullable: true
+  admin_access:
+    description: Admin role. If true, skips all permission checks.
+    example: false
+    type: boolean
+  app_access:
+    description: The users in the role are allowed to use the app.
+    example: true
+    type: boolean

packages/spec/specs/components/user.yaml

@@ -22,15 +22,25 @@ properties:
     example: "*********"
     type: string
   location:
-    description: Location of the user.
+    description: The user's location.
     example: null
     type: string
     nullable: true
-  tfa_secret:
-    description: The 2FA secret string that's used to generate one time passwords.
+  title:
+    description: The user's title.
     example: null
     type: string
     nullable: true
+  description:
+    description: The user's description.
+    example: null
+    type: string
+    nullable:
+  tags:
+    description: The user's tags.
+    example: null
+    type: array
+    nullable: true
   avatar:
     description: The user's avatar.
     example: null
@@ -40,11 +50,35 @@ properties:
       - type: string
       - $ref: "../openapi.yaml#/components/schemas/File"
     nullable: true
-  external_id:
-    description: ID used for SCIM.
+  timezone:
+    description: The user's timezone.
+    example: America/New_York
+    type: string
+  language:
+    description: The user's language used in Directus.
+    example: en-US
+    type: string
+  theme:
+    description: What theme the user is using.
+    example: auto
+    type: string
+    enum: [light, dark, auto]
+  tfa_secret:
+    description: The 2FA secret string that's used to generate one time passwords.
     example: null
     type: string
     nullable: true
+  status:
+    description: Status of the user.
+    example: active
+    type: string
+    enum: [active, invited, draft, suspended, deleted]
+  role:
+    description: Unique identifier of the role of this user.
+    example: 2f24211d-d928-469a-aea3-3c8f53d4e426
+    oneOf:
+      - type: string
+      - $ref: "../openapi.yaml#/components/schemas/Role"
   last_login:
     description: When this user logged in last.
     example: "2020-05-31 14:32:37"
@@ -56,30 +90,3 @@ properties:
     example: /my-project/settings/collections/a
     type: string
     nullable: true
-  language:
-    description: The user's language used in Directus.
-    example: en-US
-    type: string
-  role:
-    description: Unique identifier of the role of this user.
-    example: 2f24211d-d928-469a-aea3-3c8f53d4e426
-    type: string
-  status:
-    description: Status of the user.
-    example: active
-    type: string
-    enum: [active, invited, draft, suspended, deleted]
-  theme:
-    description: What theme the user is using.
-    example: auto
-    type: string
-    enum: [light, dark, auto]
-  timezone:
-    description: The user's timezone.
-    example: America/New_York
-    type: string
-  title:
-    description: The user's title.
-    example: null
-    type: string
-    nullable: true