@workos/mcp-docs-server 0.1.0 → 0.2.0

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

@@ -0,0 +1,68 @@
+---
+descriptions:
+  list_organization_roles:
+    organization_id: The ID of the organization to list roles for.
+    data: >-
+      Array of roles that apply to the organization, including both environment
+      roles and organization roles, in priority order.
+reference:
+  curl:
+    - key: list_organization_roles
+      id: list_organization_roles
+      url: /reference/roles/organization-role/list
+      title: '/authorization/organizations/:id/roles'
+      type: GET
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_organization_roles.data)
+  js:
+    - key: listOrganizationRoles
+      id: list_organization_roles
+      url: /reference/roles/organization-role/list
+      title: authorization.listOrganizationRoles()
+      parameters:
+        - key: organizationId
+          type: string
+          description: (list_organization_roles.organization_id)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: 'OrganizationRole[]'
+              description: (list_organization_roles.data)
+  python:
+    - key: list_organization_roles
+      id: list_organization_roles
+      url: /reference/roles/organization-role/list
+      title: authorization.list_organization_roles()
+      parameters:
+        - key: organization_id
+          type: str
+          description: (list_organization_roles.organization_id)
+      returns:
+        - key: anonymous
+          type: WorkOSListResource
+          unwrap: true
+          properties:
+            - key: data
+              type: 'list[OrganizationRole]'
+              description: (list_organization_roles.data)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/roles/organization-role/list.mdx
+---
+
+## List organization roles
+
+Get a list of all roles that apply to an organization. This includes both environment roles and organization-specific roles, returned in priority order.
+
+<CodeBlock referenceId="list_organization_roles">
+  <CodeBlockTab title="Request" file="list-organization-roles-request" />
+  <CodeBlockTab title="Response" file="list-organization-roles-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/roles/organization-role/remove-permission.mdx

@@ -0,0 +1,68 @@
+---
+descriptions:
+  remove_organization_role_permission:
+    permission_slug: The slug of the permission to remove from the role.
+reference:
+  curl:
+    - key: remove_organization_role_permission
+      id: remove_organization_role_permission
+      url: /reference/roles/organization-role/remove-permission
+      title: >-
+        /authorization/organizations/:id/roles/:slug/permissions/:permission_slug
+      type: DELETE
+      returns:
+        - (organization_role)
+  js:
+    - key: removeOrganizationRolePermission
+      id: remove_organization_role_permission
+      url: /reference/roles/organization-role/remove-permission
+      title: authorization.removeOrganizationRolePermission()
+      parameters:
+        - key: organizationId
+          type: string
+          description: The ID of the organization.
+        - key: roleSlug
+          type: string
+          description: The slug of the role.
+        - key: permissionSlug
+          type: string
+          description: (remove_organization_role_permission.permission_slug)
+      returns:
+        - key: OrganizationRole
+          description: (organization_role.self)
+  python:
+    - key: remove_organization_role_permission
+      id: remove_organization_role_permission
+      url: /reference/roles/organization-role/remove-permission
+      title: authorization.remove_organization_role_permission()
+      parameters:
+        - key: organization_id
+          type: str
+          description: The ID of the organization.
+        - key: slug
+          type: str
+          description: The slug of the role.
+        - key: permission_slug
+          type: str
+          description: (remove_organization_role_permission.permission_slug)
+      returns:
+        - key: OrganizationRole
+          description: (organization_role.self)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/roles/organization-role/remove-permission.mdx
+---
+
+## Remove a permission from an organization role
+
+Remove a single permission from an organization role by its slug.
+
+<CodeBlock referenceId="remove_organization_role_permission">
+  <CodeBlockTab
+    title="Request"
+    file="remove-organization-role-permission-request"
+  />
+  <CodeBlockTab
+    title="Response"
+    file="remove-organization-role-permission-response"
+  />
+</CodeBlock>

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

@@ -0,0 +1,79 @@
+---
+descriptions:
+  set_organization_role_permissions:
+    permissions: >-
+      An array of permission slugs to assign to the role. This replaces all
+      existing permissions.
+reference:
+  curl:
+    - key: set_organization_role_permissions
+      id: set_organization_role_permissions
+      url: /reference/roles/organization-role/set-permissions
+      title: '/authorization/organizations/:id/roles/:slug/permissions'
+      type: PUT
+      parameters:
+        - key: permissions
+          type: 'string[]'
+          description: (set_organization_role_permissions.permissions)
+      returns:
+        - (organization_role)
+  js:
+    - key: setOrganizationRolePermissions
+      id: set_organization_role_permissions
+      url: /reference/roles/organization-role/set-permissions
+      title: authorization.setOrganizationRolePermissions()
+      parameters:
+        - key: organizationId
+          type: string
+          description: The ID of the organization.
+        - key: roleSlug
+          type: string
+          description: The slug of the role.
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: permissions
+              type: 'string[]'
+              description: (set_organization_role_permissions.permissions)
+      returns:
+        - key: OrganizationRole
+          description: (organization_role.self)
+  python:
+    - key: set_organization_role_permissions
+      id: set_organization_role_permissions
+      url: /reference/roles/organization-role/set-permissions
+      title: authorization.set_organization_role_permissions()
+      parameters:
+        - key: organization_id
+          type: str
+          description: The ID of the organization.
+        - key: slug
+          type: str
+          description: The slug of the role.
+        - key: permissions
+          type: 'list[str]'
+          description: (set_organization_role_permissions.permissions)
+      returns:
+        - key: OrganizationRole
+          description: (organization_role.self)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/roles/organization-role/set-permissions.mdx
+---
+
+## Set permissions for an organization role
+
+Replace all permissions assigned to an organization 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_organization_role_permissions">
+  <CodeBlockTab
+    title="Request"
+    file="set-organization-role-permissions-request"
+  />
+  <CodeBlockTab
+    title="Response"
+    file="set-organization-role-permissions-response"
+  />
+</CodeBlock>

package/.docs/organized/docs/reference/roles/organization-role/update.mdx

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

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

@@ -0,0 +1,101 @@
+---
+descriptions:
+  create_permission:
+    slug: >-
+      A unique key to reference the permission. Must be lowercase and contain
+      only letters, numbers, hyphens, underscores, colons, periods, and
+      asterisks.
+    name: A descriptive name for the permission.
+    description: An optional description for the permission.
+    resource_type_slug: >-
+      The slug of the [resource type](/fga/resource-types) to scope the
+      permission to. Only applicable when using [Fine-Grained
+      Authorization](/fga). Defaults to the organization resource type if not
+      provided.
+reference:
+  curl:
+    - key: create_permission
+      id: create_permission
+      url: /reference/roles/permission/create
+      title: /authorization/permissions
+      type: POST
+      parameters:
+        - key: slug
+          type: string
+          description: (create_permission.slug)
+        - key: name
+          type: string
+          description: (create_permission.name)
+        - key: description
+          type: string
+          optional: true
+          description: (create_permission.description)
+        - key: resource_type_slug
+          type: string
+          optional: true
+          description: (create_permission.resource_type_slug)
+      returns:
+        - (permission)
+  js:
+    - key: createPermission
+      id: create_permission
+      url: /reference/roles/permission/create
+      title: authorization.createPermission()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: slug
+              type: string
+              description: (create_permission.slug)
+            - key: name
+              type: string
+              description: (create_permission.name)
+            - key: description
+              type: string
+              optional: true
+              description: (create_permission.description)
+            - key: resourceTypeSlug
+              type: string
+              optional: true
+              description: (create_permission.resource_type_slug)
+      returns:
+        - key: Permission
+          description: (permission.self)
+  python:
+    - key: create_permission
+      id: create_permission
+      url: /reference/roles/permission/create
+      title: authorization.create_permission()
+      parameters:
+        - key: slug
+          type: str
+          description: (create_permission.slug)
+        - key: name
+          type: str
+          description: (create_permission.name)
+        - key: description
+          type: str
+          optional: true
+          description: (create_permission.description)
+        - key: resource_type_slug
+          type: str
+          optional: true
+          description: (create_permission.resource_type_slug)
+      returns:
+        - key: Permission
+          description: (permission.self)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/roles/permission/create.mdx
+---
+
+## Create a permission
+
+Create a new permission in your WorkOS environment. The permission can then be assigned to environment roles and organization roles.
+
+The `slug` must be unique within the environment and must be lowercase, containing only letters, numbers, hyphens, underscores, colons, periods, and asterisks.
+
+<CodeBlock referenceId="create_permission">
+  <CodeBlockTab title="Request" file="create-permission-request" />
+  <CodeBlockTab title="Response" file="create-permission-response" />
+</CodeBlock>

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

@@ -0,0 +1,38 @@
+---
+reference:
+  curl:
+    - key: delete_permission
+      id: delete_permission
+      url: /reference/roles/permission/delete
+      title: '/authorization/permissions/:slug'
+      type: DELETE
+  js:
+    - key: deletePermission
+      id: delete_permission
+      url: /reference/roles/permission/delete
+      title: authorization.deletePermission()
+      parameters:
+        - key: slug
+          type: string
+          description: The slug of the permission to delete.
+  python:
+    - key: delete_permission
+      id: delete_permission
+      url: /reference/roles/permission/delete
+      title: authorization.delete_permission()
+      parameters:
+        - key: slug
+          type: str
+          description: The slug of the permission to delete.
+originalPath: .tmp-workos-clone/packages/docs/content/reference/roles/permission/delete.mdx
+---
+
+## Delete a permission
+
+Delete an existing permission. System permissions cannot be deleted.
+
+<CodeBlock
+  title="Request"
+  file="delete-permission-request"
+  referenceId="delete_permission"
+/>

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

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

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

@@ -0,0 +1,128 @@
+---
+descriptions:
+  permission:
+    self: 'The [Permission](/reference/roles/permission) object.'
+    object: Distinguishes the Permission object.
+    id: Unique identifier of the Permission.
+    slug: >-
+      A unique key to reference the permission. Must be lowercase and contain
+      only letters, numbers, hyphens, underscores, colons, periods, and
+      asterisks.
+    name: A descriptive name for the Permission.
+    description: A description for the Permission.
+    system: >-
+      Whether the permission is a system permission. System permissions are
+      created and managed by WorkOS and cannot be deleted.
+    resource_type_slug: The slug of the resource type the permission is scoped to.
+    created_at: The timestamp when the Permission was created.
+    updated_at: The timestamp when the Permission was last updated.
+reference:
+  curl:
+    - url: /reference/roles/permission
+      key: permission
+      id: permission
+      title: Permission
+      properties:
+        - key: object
+          type: '"permission"'
+          description: (permission.object)
+        - key: id
+          type: string
+          description: (permission.id)
+        - key: slug
+          type: string
+          description: (permission.slug)
+        - key: name
+          type: string
+          description: (permission.name)
+        - key: description
+          type: string | null
+          description: (permission.description)
+        - key: system
+          type: boolean
+          description: (permission.system)
+        - key: resource_type_slug
+          type: string
+          description: (permission.resource_type_slug)
+        - key: created_at
+          type: string
+          description: (permission.created_at)
+        - key: updated_at
+          type: string
+          description: (permission.updated_at)
+  js:
+    - url: /reference/roles/permission
+      key: Permission
+      id: permission
+      title: Permission
+      properties:
+        - key: object
+          type: '"permission"'
+          description: (permission.object)
+        - key: id
+          type: string
+          description: (permission.id)
+        - key: slug
+          type: string
+          description: (permission.slug)
+        - key: name
+          type: string
+          description: (permission.name)
+        - key: description
+          type: string | null
+          description: (permission.description)
+        - key: system
+          type: boolean
+          description: (permission.system)
+        - key: resourceTypeSlug
+          type: string
+          description: (permission.resource_type_slug)
+        - key: createdAt
+          type: string
+          description: (permission.created_at)
+        - key: updatedAt
+          type: string
+          description: (permission.updated_at)
+  python:
+    - url: /reference/roles/permission
+      key: Permission
+      id: permission
+      title: Permission
+      properties:
+        - key: object
+          type: str
+          description: (permission.object)
+        - key: id
+          type: str
+          description: (permission.id)
+        - key: slug
+          type: str
+          description: (permission.slug)
+        - key: name
+          type: str
+          description: (permission.name)
+        - key: description
+          type: str | None
+          description: (permission.description)
+        - key: system
+          type: bool
+          description: (permission.system)
+        - key: resource_type_slug
+          type: str
+          description: (permission.resource_type_slug)
+        - key: created_at
+          type: str
+          description: (permission.created_at)
+        - key: updated_at
+          type: str
+          description: (permission.updated_at)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/roles/permission/index.mdx
+---
+
+# Permission
+
+A permission represents an individual access right that can be assigned to roles. Permissions define what actions users with a given role can perform within your application.
+
+Permissions are defined at the environment level and can be assigned to both environment roles and organization roles. Each permission has a unique slug identifier that you use when assigning it to roles.
+
+<CodeBlock title="Permission" file="permission" referenceId="permission" />