@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/sso/connection/index.mdx

@@ -0,0 +1,388 @@
+---
+descriptions:
+  connection:
+    self: 'The SSO [Connection](/reference/sso/connection) object.'
+    deleted: 'The [Connection](/reference/sso/connection) that was deleted.'
+    object: Distinguishes the Connection object.
+    id: Unique identifier for the Connection.
+    organization_id: Unique identifier for the Organization in which the Connection resides.
+    connection_type: >
+      The type of the SSO Connection used to authenticate the user. The
+      Connection type may be used to dynamically generate authorization URLs.
+
+
+      Possible values:
+
+      - `ADFSSAML`
+
+      - `AdpOidc`
+
+      - `AppleOAuth`
+
+      - `Auth0SAML`
+
+      - `AzureSAML`
+
+      - `CasSAML`
+
+      - `ClassLinkSAML`
+
+      - `CloudflareSAML`
+
+      - `CyberArkSAML`
+
+      - `DuoSAML`
+
+      - `GenericOIDC`
+
+      - `GenericSAML`
+
+      - `GitHubOAuth`
+
+      - `GoogleOAuth`
+
+      - `GoogleSAML`
+
+      - `JumpCloudSAML`
+
+      - `KeycloakSAML`
+
+      - `LastPassSAML`
+
+      - `LoginGovOidc`
+
+      - `MagicLink`
+
+      - `MicrosoftOAuth`
+
+      - `MiniOrangeSAML`
+
+      - `NetIqSAML`
+
+      - `OktaSAML`
+
+      - `OneLoginSAML`
+
+      - `OracleSAML`
+
+      - `PingFederateSAML`
+
+      - `PingOneSAML`
+
+      - `RipplingSAML`
+
+      - `SalesforceSAML`
+
+      - `ShibbolethGenericSAML`
+
+      - `ShibbolethSAML`
+
+      - `SimpleSamlPhpSAML`
+
+      - `VMwareSAML`
+    name: >-
+      A human-readable name for the Connection. This will most commonly be the
+      organization's name.
+    state:
+      lowercase: >
+        Indicates whether a Connection is able to authenticate users. Possible
+        values:
+
+        - `active`
+
+        - `inactive`
+
+        - `validating`
+
+
+        Connections that can’t authenticate users are `inactive`. When a new
+        connection is configured, it transitions to the `validating` state until
+        its first successful authentication. After it successfully authorizes a
+        user for the first time, the connection state changes to `active`.
+      titlecase: >
+        Indicates whether a Connection is able to authenticate users. Possible
+        values:
+
+        - `Active`
+
+        - `Inactive`
+
+        - `Validating`
+
+
+        Connections that can’t authenticate users are `inactive`. When a new
+        connection is configured, it transitions to the `validating` state until
+        its first successful authentication. After it successfully authorizes a
+        user for the first time, the connection state changes to `active`.
+    domains: 'List of [Organization Domains](/reference/organization-domain).'
+    created_at: The timestamp when the Connection was created.
+    updated_at: The timestamp when the Connection was last updated.
+reference:
+  curl:
+    - url: /reference/sso/connection
+      key: connection
+      id: connection
+      title: connection
+      properties:
+        - key: object
+          type: '"connection"'
+          description: (connection.object)
+        - key: id
+          type: string
+          description: (connection.id)
+        - key: organization_id
+          optional: true
+          type: string
+          description: (connection.organization_id)
+        - key: connection_type
+          type: enum
+          description: (connection.connection_type)
+        - key: name
+          type: string
+          description: (connection.name)
+        - key: state
+          type: enum
+          description: (connection.state.lowercase)
+        - key: created_at
+          type: string
+          description: (connection.created_at)
+        - key: updated_at
+          type: string
+          description: (connection.updated_at)
+        - key: domains
+          type: array
+          description: (connection.domains)
+  dotnet:
+    - url: /reference/sso/connection
+      key: Connection
+      id: connection
+      title: class Connection
+      properties:
+        - key: Object
+          type: '"connection"'
+          description: (connection.object)
+        - key: Id
+          type: string
+          description: (connection.id)
+        - key: OrganizationId
+          optional: true
+          type: string
+          description: (connection.organization_id)
+        - key: Type
+          type: string
+          description: (connection.connection_type)
+        - key: Name
+          type: string
+          description: (connection.name)
+        - key: State
+          type: ConnectionState
+          description: (connection.state.titlecase)
+        - key: CreatedAt
+          type: string
+          description: (connection.created_at)
+        - key: UpdatedAt
+          type: string
+          description: (connection.updated_at)
+  php:
+    - url: /reference/sso/connection
+      key: Connection
+      id: connection
+      title: WorkOS\Resource\Connection
+      properties:
+        - key: id
+          type: string
+          description: (connection.id)
+        - key: organizationId
+          optional: true
+          type: string
+          description: (connection.organization_id)
+        - key: connectionType
+          type: string
+          optional: true
+          description: (connection.connection_type)
+        - key: name
+          type: string
+          description: (connection.name)
+        - key: state
+          type: string
+          description: (connection.state.lowercase)
+        - key: createdAt
+          type: string
+          description: (connection.created_at)
+        - key: updatedAt
+          type: string
+          description: (connection.updated_at)
+  ruby:
+    - url: /reference/sso/connection
+      key: Connection
+      id: connection
+      title: class Connection
+      properties:
+        - key: id
+          type: String
+          description: (connection.id)
+        - key: organization_id
+          optional: true
+          type: String
+          description: (connection.organization_id)
+        - key: connection_type
+          type: String
+          description: (connection.connection_type)
+        - key: name
+          type: String
+          description: (connection.name)
+        - key: state
+          type: String
+          description: (connection.state.lowercase)
+        - key: created_at
+          type: String
+          description: (connection.created_at)
+        - key: updated_at
+          type: String
+          description: (connection.updated_at)
+        - key: domains
+          type: 'Array[Hash]'
+          description: (connection.domains)
+  python:
+    - url: /reference/sso/connection
+      key: Connection
+      id: connection
+      title: ConnectionWithDomains
+      properties:
+        - key: id
+          type: str
+          description: (connection.id)
+        - key: organization_id
+          optional: true
+          type: str
+          description: (connection.organization_id)
+        - key: connection_type
+          type: ConnectionType
+          description: (connection.connection_type)
+        - key: name
+          type: str
+          description: (connection.name)
+        - key: state
+          type: str
+          description: (connection.state.lowercase)
+        - key: created_at
+          type: str
+          description: (connection.created_at)
+        - key: updated_at
+          type: str
+          description: (connection.updated_at)
+        - key: domains
+          type: 'list[ConnectionDomain]'
+          description: (connection.domains)
+  js:
+    - url: /reference/sso/connection
+      key: Connection
+      id: connection
+      title: interface Connection
+      properties:
+        - key: id
+          type: string
+          description: (connection.id)
+        - key: organizationId
+          optional: true
+          type: string
+          description: (connection.organization_id)
+        - key: type
+          type: string
+          optional: true
+          description: (connection.connection_type)
+        - key: name
+          type: string
+          description: (connection.name)
+        - key: state
+          type: string
+          description: (connection.state.lowercase)
+        - key: createdAt
+          type: string
+          description: (connection.created_at)
+        - key: updatedAt
+          type: string
+          description: (connection.updated_at)
+        - key: domains
+          type: 'OrganizationDomain[]'
+          description: (connection.domains)
+  go:
+    - url: /reference/sso/connection
+      key: Connection
+      id: connection
+      title: sso.Connection
+      properties:
+        - key: ID
+          type: string
+          description: (connection.id)
+        - key: OrganizationID
+          optional: true
+          type: string
+          description: (connection.organization_id)
+        - key: ConnectionType
+          type: sso.ConnectionType
+          description: (connection.connection_type)
+        - key: Name
+          type: string
+          description: (connection.name)
+        - key: State
+          type: sso.ConnectionState
+          description: (connection.state.lowercase)
+        - key: CreatedAt
+          type: string
+          description: (connection.created_at)
+        - key: UpdatedAt
+          type: string
+          description: (connection.updated_at)
+        - key: Domains
+          type: '[]sso.ConnectionDomain'
+          description: (connection.domains)
+  java:
+    - url: /reference/sso/connection
+      key: Connection
+      id: connection
+      title: class Connection
+      properties:
+        - key: obj
+          type: '"connection"'
+          description: (connection.object)
+        - key: id
+          type: String
+          description: (connection.id)
+        - key: organizationId
+          optional: true
+          type: String
+          description: (connection.organization_id)
+        - key: connectionType
+          type: ConnectionType
+          optional: true
+          description: (connection.connection_type)
+        - key: domains
+          type: List<ConnectionDomain>
+          description: (connection.domains)
+        - key: name
+          type: String
+          description: (connection.name)
+        - key: state
+          type: ConnectionState
+          description: (connection.state.titlecase)
+        - key: createdAt
+          type: String
+          description: (connection.created_at)
+        - key: updatedAt
+          type: String
+          description: (connection.updated_at)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/sso/connection/index.mdx
+---
+
+## Connection
+
+A connection represents the relationship between WorkOS and any collection of application users. This collection of application users may include personal or enterprise identity providers. As a layer of abstraction, a WorkOS connection rests between an application and its users, separating an application from the implementation details required by specific standards like [OAuth 2.0](/glossary/oauth-2-0) and [SAML](/glossary/saml).
+
+See the [events reference](/events/connection) documentation for the connection events.
+
+<CodeBlock
+  title="Example Connection"
+  file="connection"
+  referenceId="connection"
+/>

package/.docs/organized/docs/reference/sso/connection/list.mdx

@@ -0,0 +1,320 @@
+---
+descriptions:
+  list_connections:
+    data: >-
+      An array of [Connections](/reference/sso/connection) ordered by creation
+      time.
+    connection_type: Filter Connections by their type.
+    organization_id: Filter Connections by their associated organization.
+    domain: Filter Connections by their associated domain.
+reference:
+  curl:
+    - key: listConnections
+      id: list_connections
+      url: /reference/sso/connection/list
+      title: /connections
+      type: GET
+      parameters:
+        - key: connection_type
+          optional: true
+          type: string
+          description: (list_connections.connection_type)
+        - key: domain
+          optional: true
+          type: string
+          description: (list_connections.domain)
+        - key: organization_id
+          optional: true
+          type: string
+          description: (list_connections.organization_id)
+        - (after)
+        - (before)
+        - (limit)
+        - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              description: (list_connections.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+  dotnet:
+    - key: ListConnections
+      id: list_connections
+      url: /reference/sso/connection/list
+      title: ssoService.ListConnections()
+      parameters:
+        - key: options
+          type: ListConnectionsOptions
+          expanded: true
+          properties:
+            - key: Type
+              optional: true
+              type: string
+              description: (list_connections.connection_type)
+            - key: Domain
+              optional: true
+              type: string
+              description: (list_connections.domain)
+            - key: OrganizationId
+              optional: true
+              type: string
+              description: (list_connections.organization_id)
+            - (Limit)
+            - (Before)
+            - (After)
+            - (Order)
+        - (cancellationToken)
+      returns:
+        - key: Task<WorkOSList<Connection>>
+          expanded: true
+          properties:
+            - key: Data
+              type: List<Connection>
+              description: (list_connections.data)
+            - key: ListMetadata
+              type: ListMetadata
+              properties:
+                - (Before)
+                - (After)
+  ruby:
+    - key: list_connections
+      id: list_connections
+      url: /reference/sso/connection/list
+      title: SSO.list_connections()
+      parameters:
+        - key: connection_type
+          optional: true
+          type: String
+          description: (list_connections.connection_type)
+        - key: domain
+          optional: true
+          type: String
+          description: (list_connections.domain)
+        - key: organization_id
+          optional: true
+          type: String
+          description: (list_connections.organization_id)
+        - (after)
+        - (before)
+        - (limit)
+        - (order)
+      returns:
+        - key: anonymous
+          type: Struct
+          unwrap: true
+          properties:
+            - key: data
+              type: 'Array[Connection]'
+              description: (list_connections.data)
+            - key: list_metadata
+              type: Hash
+              properties:
+                - (before)
+                - (after)
+  php:
+    - key: listConnections
+      id: list_connections
+      url: /reference/sso/connection/list
+      title: $sso->listConnections()
+      parameters:
+        - key: connectionType
+          optional: true
+          type: string
+          description: (list_connections.connection_type)
+        - key: domain
+          optional: true
+          type: string
+          description: (list_connections.domain)
+        - key: organizationId
+          optional: true
+          type: string
+          description: (list_connections.organization_id)
+        - (limit)
+        - (before)
+        - (after)
+        - (order)
+      returns:
+        - key: anonymous
+          type: array
+          unwrap: true
+          properties:
+            - key: data
+              type: 'Connection[]'
+              description: (list_connections.data)
+            - (before)
+            - (after)
+  python:
+    - key: list_connections
+      id: list_connections
+      url: /reference/sso/connection/list
+      title: sso.list_connections()
+      parameters:
+        - key: connection_type
+          optional: true
+          type: str
+          description: (list_connections.connection_type)
+        - key: domain
+          optional: true
+          type: str
+          description: (list_connections.domain)
+        - key: organization_id
+          optional: true
+          type: str
+          description: (list_connections.organization_id)
+        - (after)
+        - (before)
+        - (limit)
+        - (order)
+      returns:
+        - key: anonymous
+          type: WorkOSListResource
+          unwrap: true
+          properties:
+            - key: data
+              type: 'list[ConnectionWithDomains]'
+              description: (list_connections.data)
+            - key: list_metadata
+              type: ListMetadata
+              properties:
+                - (before)
+                - (after)
+  js:
+    - key: listConnections
+      id: list_connections
+      url: /reference/sso/connection/list
+      title: sso.listConnections()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: connectionType
+              optional: true
+              type: string
+              description: (list_connections.connection_type)
+            - key: domain
+              optional: true
+              type: string
+              description: (list_connections.domain)
+            - key: organizationId
+              optional: true
+              type: string
+              description: (list_connections.organization_id)
+            - (after)
+            - (before)
+            - (limit)
+            - (order)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: 'Connection[]'
+              description: (list_connections.data)
+            - key: listMetadata
+              type: object
+              properties:
+                - (before)
+                - (after)
+  go:
+    - key: ListConnections
+      id: list_connections
+      url: /reference/sso/connection/list
+      title: sso.ListConnections()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: sso.ListConnectionsOpts
+          expanded: true
+          properties:
+            - key: ConnectionType
+              optional: true
+              type: string
+              description: (list_connections.connection_type)
+            - key: Domain
+              optional: true
+              type: string
+              description: (list_connections.domain)
+            - key: OrganizationID
+              optional: true
+              type: string
+              description: (list_connections.organization_id)
+            - (Limit)
+            - (Before)
+            - (After)
+            - (Order)
+      returns:
+        - key: list
+          type: sso.ListConnectionsResponse
+          expanded: true
+          properties:
+            - key: Data
+              type: '[]sso.Connection'
+              description: (list_connections.data)
+            - key: ListMetadata
+              type: common.ListMetadata
+              properties:
+                - (Before)
+                - (After)
+        - (err)
+  java:
+    - key: listConnections
+      id: list_connections
+      url: /reference/sso/connection/list
+      title: sso.listConnections()
+      parameters:
+        - key: options
+          type: ListConnectionsOptions
+          expanded: true
+          properties:
+            - key: connectionType
+              optional: true
+              type: String
+              description: (list_connections.connection_type)
+            - key: domain
+              optional: true
+              type: String
+              description: (list_connections.domain)
+            - key: organizationId
+              optional: true
+              type: String
+              description: (list_connections.organization_id)
+            - (limit)
+            - (before)
+            - (after)
+            - (order)
+            - key: builder()
+              type: ListConnectionsOptionsBuilder
+              description: (java.builder)
+      returns:
+        - key: connectionList
+          type: ConnectionList
+          expanded: true
+          properties:
+            - key: data
+              type: List<Connection>
+              description: (list_connections.data)
+            - key: listMetadata
+              type: ListMetadata
+              properties:
+                - (before)
+                - (after)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/sso/connection/list.mdx
+---
+
+## List Connections
+
+Get a list of all of your existing connections matching the criteria specified.
+
+<CodeBlock referenceId="list_connections">
+  <CodeBlockTab title="Request" file="list-connections-request" />
+  <CodeBlockTab title="Response" file="list-connections-response" />
+</CodeBlock>