@workos/mcp-docs-server 0.1.0 → 0.2.0

package/.docs/organized/docs/reference/roles/permission/list.mdx

@@ -0,0 +1,91 @@
+---
+descriptions:
+  list_permissions:
+    data: 'Array of [Permissions](/reference/roles/permission).'
+reference:
+  curl:
+    - key: list_permissions
+      id: list_permissions
+      url: /reference/roles/permission/list
+      title: /authorization/permissions
+      type: GET
+      parameters:
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_permissions.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+  js:
+    - key: listPermissions
+      id: list_permissions
+      url: /reference/roles/permission/list
+      title: authorization.listPermissions()
+      parameters:
+        - key: options
+          type: object
+          optional: true
+          unwrap: true
+          properties:
+            - (limit)
+            - (before)
+            - (after)
+            - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: 'Permission[]'
+              description: (list_permissions.data)
+            - key: listMetadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+  python:
+    - key: list_permissions
+      id: list_permissions
+      url: /reference/roles/permission/list
+      title: authorization.list_permissions()
+      parameters:
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: anonymous
+          type: WorkOSListResource
+          unwrap: true
+          properties:
+            - key: data
+              type: 'list[Permission]'
+              description: (list_permissions.data)
+            - key: list_metadata
+              type: ListMetadata
+              properties:
+                - (before)
+                - (after)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/roles/permission/list.mdx
+---
+
+## List permissions
+
+Get a list of all permissions in your WorkOS environment.
+
+<CodeBlock referenceId="list_permissions">
+  <CodeBlockTab title="Request" file="list-permissions-request" />
+  <CodeBlockTab title="Response" file="list-permissions-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/roles/permission/update.mdx

@@ -0,0 +1,80 @@
+---
+descriptions:
+  update_permission:
+    name: The new name for the permission.
+    description: >-
+      The new description for the permission. Set to `null` to remove the
+      description.
+reference:
+  curl:
+    - key: update_permission
+      id: update_permission
+      url: /reference/roles/permission/update
+      title: '/authorization/permissions/:slug'
+      type: PATCH
+      parameters:
+        - key: name
+          type: string
+          optional: true
+          description: (update_permission.name)
+        - key: description
+          type: string | null
+          optional: true
+          description: (update_permission.description)
+      returns:
+        - (permission)
+  js:
+    - key: updatePermission
+      id: update_permission
+      url: /reference/roles/permission/update
+      title: authorization.updatePermission()
+      parameters:
+        - key: slug
+          type: string
+          description: The slug of the permission to update.
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: name
+              type: string
+              optional: true
+              description: (update_permission.name)
+            - key: description
+              type: string | null
+              optional: true
+              description: (update_permission.description)
+      returns:
+        - key: Permission
+          description: (permission.self)
+  python:
+    - key: update_permission
+      id: update_permission
+      url: /reference/roles/permission/update
+      title: authorization.update_permission()
+      parameters:
+        - key: slug
+          type: str
+          description: The slug of the permission to update.
+        - key: name
+          type: str
+          optional: true
+          description: (update_permission.name)
+        - key: description
+          type: str | None
+          optional: true
+          description: (update_permission.description)
+      returns:
+        - key: Permission
+          description: (permission.self)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/roles/permission/update.mdx
+---
+
+## Update a permission
+
+Update an existing permission. Only the fields provided in the request body will be updated.
+
+<CodeBlock referenceId="update_permission">
+  <CodeBlockTab title="Request" file="update-permission-request" />
+  <CodeBlockTab title="Response" file="update-permission-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/roles/role/add-permission.mdx

@@ -0,0 +1,63 @@
+---
+descriptions:
+  add_role_permission:
+    slug: The slug of the permission to add to the role.
+reference:
+  curl:
+    - key: add_role_permission
+      id: add_role_permission
+      url: /reference/roles/role/add-permission
+      title: '/authorization/roles/:slug/permissions'
+      type: POST
+      parameters:
+        - key: slug
+          type: string
+          description: (add_role_permission.slug)
+      returns:
+        - (role)
+  js:
+    - key: addRolePermission
+      id: add_role_permission
+      url: /reference/roles/role/add-permission
+      title: authorization.addRolePermission()
+      parameters:
+        - key: roleSlug
+          type: string
+          description: The slug of the role.
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: permissionSlug
+              type: string
+              description: (add_role_permission.slug)
+      returns:
+        - key: Role
+          description: (role.self)
+  python:
+    - key: add_role_permission
+      id: add_role_permission
+      url: /reference/roles/role/add-permission
+      title: authorization.add_role_permission()
+      parameters:
+        - key: slug
+          type: str
+          description: The slug of the role.
+        - key: permission_slug
+          type: str
+          description: (add_role_permission.slug)
+      returns:
+        - key: Role
+          description: (role.self)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/roles/role/add-permission.mdx
+---
+
+## Add a permission to an environment role
+
+Add a single permission to an environment role. If the permission is already assigned to the role, this operation has no effect.
+
+<CodeBlock referenceId="add_role_permission">
+  <CodeBlockTab title="Request" file="add-role-permission-request" />
+  <CodeBlockTab title="Response" file="add-role-permission-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/roles/role/create.mdx

@@ -0,0 +1,103 @@
+---
+descriptions:
+  create_role:
+    slug: >
+      A unique key to reference the role. Must be lowercase and contain only
+      letters, numbers, hyphens, and underscores.
+    name: A name for the role.
+    description: An optional description for the role.
+    resource_type_slug: >-
+      The slug of the [resource type](/fga/resource-types) to scope the role to.
+      Only applicable when using [Fine-Grained Authorization](/fga). Defaults to
+      the organization resource type if not provided.
+reference:
+  curl:
+    - key: create_role
+      id: create_role
+      url: /reference/roles/role/create
+      title: /authorization/roles
+      type: POST
+      parameters:
+        - key: slug
+          type: string
+          description: (create_role.slug)
+        - key: name
+          type: string
+          description: (create_role.name)
+        - key: description
+          type: string
+          optional: true
+          description: (create_role.description)
+        - key: resource_type_slug
+          type: string
+          optional: true
+          description: (create_role.resource_type_slug)
+      returns:
+        - (role)
+  js:
+    - key: createRole
+      id: create_role
+      url: /reference/roles/role/create
+      title: authorization.createRole()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: slug
+              type: string
+              description: (create_role.slug)
+            - key: name
+              type: string
+              description: (create_role.name)
+            - key: description
+              type: string
+              optional: true
+              description: (create_role.description)
+            - key: resourceTypeSlug
+              type: string
+              optional: true
+              description: (create_role.resource_type_slug)
+      returns:
+        - key: Role
+          description: (role.self)
+  python:
+    - key: create_role
+      id: create_role
+      url: /reference/roles/role/create
+      title: authorization.create_role()
+      parameters:
+        - key: slug
+          type: str
+          description: (create_role.slug)
+        - key: name
+          type: str
+          description: (create_role.name)
+        - key: description
+          type: str
+          optional: true
+          description: (create_role.description)
+        - key: resource_type_slug
+          type: str
+          optional: true
+          description: (create_role.resource_type_slug)
+      returns:
+        - key: Role
+          description: (role.self)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/roles/role/create.mdx
+---
+
+## Create an environment role
+
+Create a new environment role.
+
+The `slug` must be unique across all environment roles and can only contain lowercase letters, numbers, hyphens, and underscores.
+
+<Callout type="info">
+  New roles are placed at the bottom of the priority order.
+</Callout>
+
+<CodeBlock referenceId="create_role">
+  <CodeBlockTab title="Request" file="create-role-request" />
+  <CodeBlockTab title="Response" file="create-role-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/roles/role/get.mdx

@@ -0,0 +1,52 @@
+---
+descriptions:
+  get_role:
+    slug: The unique slug of the role to retrieve.
+reference:
+  curl:
+    - key: get_role
+      id: get_role
+      url: /reference/roles/role/get
+      title: '/authorization/roles/:slug'
+      type: GET
+      parameters:
+        - key: slug
+          type: string
+          description: (get_role.slug)
+      returns:
+        - (role)
+  js:
+    - key: getRole
+      id: get_role
+      url: /reference/roles/role/get
+      title: authorization.getRole()
+      parameters:
+        - key: slug
+          type: string
+          description: (get_role.slug)
+      returns:
+        - key: Role
+          description: (role.self)
+  python:
+    - key: get_role
+      id: get_role
+      url: /reference/roles/role/get
+      title: authorization.get_role()
+      parameters:
+        - key: slug
+          type: str
+          description: (get_role.slug)
+      returns:
+        - key: Role
+          description: (role.self)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/roles/role/get.mdx
+---
+
+## Get an environment role
+
+Retrieve an environment role by its unique slug.
+
+<CodeBlock referenceId="get_role">
+  <CodeBlockTab title="Request" file="get-role-request" />
+  <CodeBlockTab title="Response" file="get-role-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/roles/role/index.mdx

@@ -0,0 +1,135 @@
+---
+descriptions:
+  role:
+    self: 'The [Environment Role](/reference/roles/role) object.'
+    object: Distinguishes the Role object.
+    id: Unique identifier of the Role.
+    name: A descriptive name for the Role. This field does not need to be unique.
+    slug: >-
+      A unique key to reference the role. Must be lowercase and contain only
+      letters, numbers, hyphens, and underscores.
+    description: A description for the Role.
+    permissions: A list of permission slugs assigned to the role.
+    type: 'The type of Role. For environment roles, this is always `EnvironmentRole`.'
+    resource_type_slug: The slug of the resource type the role is scoped to.
+    created_at: The timestamp when the Role was created.
+    updated_at: The timestamp when the Role was last updated.
+reference:
+  curl:
+    - url: /reference/roles/role
+      key: role
+      id: role
+      title: Role
+      properties:
+        - key: object
+          type: '"role"'
+          description: (role.object)
+        - key: id
+          type: string
+          description: (role.id)
+        - key: name
+          type: string
+          description: (role.name)
+        - key: slug
+          type: string
+          description: (role.slug)
+        - key: description
+          type: string | null
+          description: (role.description)
+        - key: permissions
+          type: 'string[]'
+          description: (role.permissions)
+        - key: type
+          type: '"EnvironmentRole"'
+          description: (role.type)
+        - key: resource_type_slug
+          type: string
+          description: (role.resource_type_slug)
+        - key: created_at
+          type: string
+          description: (role.created_at)
+        - key: updated_at
+          type: string
+          description: (role.updated_at)
+  js:
+    - url: /reference/roles/role
+      key: Role
+      id: role
+      title: Role
+      properties:
+        - key: object
+          type: '"role"'
+          description: (role.object)
+        - key: id
+          type: string
+          description: (role.id)
+        - key: name
+          type: string
+          description: (role.name)
+        - key: slug
+          type: string
+          description: (role.slug)
+        - key: description
+          type: string | null
+          description: (role.description)
+        - key: permissions
+          type: 'string[]'
+          description: (role.permissions)
+        - key: type
+          type: '"EnvironmentRole"'
+          description: (role.type)
+        - key: resourceTypeSlug
+          type: string
+          description: (role.resource_type_slug)
+        - key: createdAt
+          type: string
+          description: (role.created_at)
+        - key: updatedAt
+          type: string
+          description: (role.updated_at)
+  python:
+    - url: /reference/roles/role
+      key: Role
+      id: role
+      title: Role
+      properties:
+        - key: object
+          type: str
+          description: (role.object)
+        - key: id
+          type: str
+          description: (role.id)
+        - key: name
+          type: str
+          description: (role.name)
+        - key: slug
+          type: str
+          description: (role.slug)
+        - key: description
+          type: str | None
+          description: (role.description)
+        - key: permissions
+          type: 'list[str]'
+          description: (role.permissions)
+        - key: type
+          type: str
+          description: (role.type)
+        - key: resource_type_slug
+          type: str
+          description: (role.resource_type_slug)
+        - key: created_at
+          type: str
+          description: (role.created_at)
+        - key: updated_at
+          type: str
+          description: (role.updated_at)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/roles/role/index.mdx
+---
+
+# Environment Role
+
+An environment role is an access control resource defined at the environment level. Environment roles can be assigned to [organization memberships](/reference/authkit/organization-membership), [directory users](/directory-sync/identity-provider-role-assignment), and [SSO profiles](/sso/identity-provider-role-assignment).
+
+Environment roles provide a consistent set of roles across all organizations in your environment. Each role has a unique slug identifier. Roles can have permissions assigned to them.
+
+<CodeBlock title="Environment Role" file="role" referenceId="role" />

package/.docs/organized/docs/reference/roles/role/list.mdx

@@ -0,0 +1,56 @@
+---
+descriptions:
+  list_roles:
+    data: 'Array of [Environment Roles](/reference/roles/role) in priority order.'
+reference:
+  curl:
+    - key: list_roles
+      id: list_roles
+      url: /reference/roles/role/list
+      title: /authorization/roles
+      type: GET
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_roles.data)
+  js:
+    - key: listRoles
+      id: list_roles
+      url: /reference/roles/role/list
+      title: authorization.listRoles()
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: 'Role[]'
+              description: (list_roles.data)
+  python:
+    - key: list_roles
+      id: list_roles
+      url: /reference/roles/role/list
+      title: authorization.list_roles()
+      returns:
+        - key: anonymous
+          type: WorkOSListResource
+          unwrap: true
+          properties:
+            - key: data
+              type: 'list[Role]'
+              description: (list_roles.data)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/roles/role/list.mdx
+---
+
+## List environment roles
+
+Get a list of all environment roles. Roles are returned in priority order.
+
+<CodeBlock referenceId="list_roles">
+  <CodeBlockTab title="Request" file="list-roles-request" />
+  <CodeBlockTab title="Response" file="list-roles-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/roles/role/set-permissions.mdx

@@ -0,0 +1,67 @@
+---
+descriptions:
+  set_role_permissions:
+    permissions: >-
+      An array of permission slugs to assign to the role. This replaces all
+      existing permissions.
+reference:
+  curl:
+    - key: set_role_permissions
+      id: set_role_permissions
+      url: /reference/roles/role/set-permissions
+      title: '/authorization/roles/:slug/permissions'
+      type: PUT
+      parameters:
+        - key: permissions
+          type: 'string[]'
+          description: (set_role_permissions.permissions)
+      returns:
+        - (role)
+  js:
+    - key: setRolePermissions
+      id: set_role_permissions
+      url: /reference/roles/role/set-permissions
+      title: authorization.setRolePermissions()
+      parameters:
+        - key: slug
+          type: string
+          description: The slug of the role.
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: permissions
+              type: 'string[]'
+              description: (set_role_permissions.permissions)
+      returns:
+        - key: Role
+          description: (role.self)
+  python:
+    - key: set_role_permissions
+      id: set_role_permissions
+      url: /reference/roles/role/set-permissions
+      title: authorization.set_role_permissions()
+      parameters:
+        - key: slug
+          type: str
+          description: The slug of the role.
+        - key: permissions
+          type: 'list[str]'
+          description: (set_role_permissions.permissions)
+      returns:
+        - key: Role
+          description: (role.self)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/roles/role/set-permissions.mdx
+---
+
+## Set permissions for an environment role
+
+Replace all permissions assigned to an environment role. This operation removes any existing permissions and assigns the provided permissions.
+
+To remove all permissions from a role, pass an empty array.
+
+<CodeBlock referenceId="set_role_permissions">
+  <CodeBlockTab title="Request" file="set-role-permissions-request" />
+  <CodeBlockTab title="Response" file="set-role-permissions-response" />
+</CodeBlock>