Snyk
Snyk Groups API

The Groups API from Snyk — 7 operation(s) for groups.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.3
info:
  title: Snyk AccessRequests Groups API
  version: REST
servers:
- description: Snyk REST API
  url: https://api.snyk.io/rest
security:
- APIToken: []
- BearerAuth: []
tags:
- name: Groups
paths:
  /groups:
    get:
      description: Returns a list of groups which a user is a member of
      operationId: listGroups
      parameters:
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/EndingBefore'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Version'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/Group'
                    type: array
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/Links'
                required:
                - jsonapi
                - data
                - links
                type: object
          description: A list of groups is returned
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Get all groups (Early Access)
      tags:
      - Groups
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2022-01-31~experimental
      - 2023-01-30~beta
      x-snyk-api-resource: groups
      x-snyk-api-stability: beta
      x-snyk-api-version: 2023-01-30~beta
      x-stability-level: beta
  /groups/{group_id}/memberships:
    get:
      description: 'Returns all memberships of the group


        #### Required permissions


        - `View Group Memberships (group.membership.read)`'
      operationId: listGroupMemberships
      parameters:
      - description: The ID of the group
        in: path
        name: group_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/EndingBefore'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Version'
      - $ref: '#/components/parameters/SortBy__0'
      - $ref: '#/components/parameters/SortOrder__0'
      - $ref: '#/components/parameters/EmailFilter'
      - $ref: '#/components/parameters/UserIdFilter'
      - $ref: '#/components/parameters/UsernameFilter'
      - $ref: '#/components/parameters/RoleFilter'
      - $ref: '#/components/parameters/IncludeGroupMembershipCount'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/GroupMembershipResponseData'
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/Links'
                required:
                - jsonapi
                - data
                - links
                type: object
          description: List of group memberships is returned
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Get all memberships of the group
      tags:
      - Groups
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2024-05-09~experimental
      - '2024-08-25'
      x-snyk-api-resource: groups
      x-snyk-api-stability: ga
      x-snyk-api-version: '2024-08-25'
      x-stability-level: stable
    post:
      description: 'Create a group membership for a user with role


        #### Required permissions


        - `Add Group Memberships (group.membership.add)`'
      operationId: createGroupMembership
      parameters:
      - description: The ID of the group
        in: path
        name: group_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/Version'
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              $ref: '#/components/schemas/CreateGroupMembershipRequestBody'
      responses:
        '201':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/GroupMembership'
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/Links'
                type: object
          description: Membership for the group was created
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            location:
              $ref: '#/components/headers/LocationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
      summary: Create a group membership for a user with role
      tags:
      - Groups
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2024-05-09~experimental
      - '2024-08-25'
      x-snyk-api-resource: groups
      x-snyk-api-stability: ga
      x-snyk-api-version: '2024-08-25'
      x-stability-level: stable
  /groups/{group_id}/memberships/{membership_id}:
    delete:
      description: 'Deletes a membership from a group


        #### Required permissions


        - `Delete Group Memberships (group.membership.delete)`'
      operationId: deleteGroupMembership
      parameters:
      - description: The ID of the group
        in: path
        name: group_id
        required: true
        schema:
          format: uuid
          type: string
      - description: The ID of the Group Membership
        in: path
        name: membership_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/Cascade'
      - $ref: '#/components/parameters/Version'
      responses:
        '204':
          description: group membership is deleted from Group
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
      summary: Delete a membership from a group
      tags:
      - Groups
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2024-05-09~experimental
      - '2024-08-25'
      x-snyk-api-resource: groups
      x-snyk-api-stability: ga
      x-snyk-api-version: '2024-08-25'
      x-stability-level: stable
    patch:
      description: 'Update a role from a group membership


        #### Required permissions


        - `Edit Group Memberships (group.membership.edit)`'
      operationId: updateGroupUserMembership
      parameters:
      - description: The ID of the group
        in: path
        name: group_id
        required: true
        schema:
          format: uuid
          type: string
      - description: The ID of the Group Membership
        in: path
        name: membership_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/Version'
      requestBody:
        content:
          application/vnd.api+json:
            schema:
              properties:
                data:
                  $ref: '#/components/schemas/MembershipPatchRequestBody'
              type: object
      responses:
        '204':
          $ref: '#/components/responses/204'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Update a role from a group membership
      tags:
      - Groups
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2024-05-09~experimental
      - '2024-08-25'
      x-snyk-api-resource: groups
      x-snyk-api-stability: ga
      x-snyk-api-version: '2024-08-25'
      x-stability-level: stable
  /groups/{group_id}/org_memberships:
    get:
      description: 'Get list of org memberships of a group user


        #### Required permissions


        - `View Group Memberships (group.membership.read)`


        - `View Organizations (group.org.list)`'
      operationId: listGroupUserOrgMemberships
      parameters:
      - description: The ID of the group
        in: path
        name: group_id
        required: true
        schema:
          format: uuid
          type: string
      - description: The ID of the User
        in: query
        name: user_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/OrgName'
      - $ref: '#/components/parameters/RoleFilter'
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/EndingBefore'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Version'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/GroupMembershipOrgMembership'
                    type: array
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/Links'
                  meta:
                    properties:
                      org_membership_count:
                        description: Org memberships for this user within this group.
                        type: number
                    type: object
                required:
                - jsonapi
                - data
                - links
                type: object
          description: A list of org memberships is returned
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
      summary: Get list of org memberships of a group user
      tags:
      - Groups
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - '2024-08-25'
      x-snyk-api-resource: groups
      x-snyk-api-stability: ga
      x-snyk-api-version: '2024-08-25'
      x-stability-level: stable
  /groups/{group_id}/sso_connections:
    get:
      description: 'Returns a list of SSO connections for a group


        #### Required permissions


        - `View SSO settings (group.sso.read)`'
      operationId: listGroupSsoConnections
      parameters:
      - description: The ID of the group
        in: path
        name: group_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/EndingBefore'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Version'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/SSOConnection'
                    type: array
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/Links'
                required:
                - jsonapi
                - data
                - links
                type: object
          description: List of SSO connections is returned
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Get all SSO connections for a group (Early Access)
      tags:
      - Groups
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2022-01-31~experimental
      - 2023-01-30~beta
      x-snyk-api-resource: groups
      x-snyk-api-stability: beta
      x-snyk-api-version: 2023-01-30~beta
      x-stability-level: beta
  /groups/{group_id}/sso_connections/{sso_id}/users:
    get:
      description: 'Returns a list of users for a SSO connection


        #### Required permissions


        - `View SSO settings (group.sso.read)`


        - `View users (group.user.read)`'
      operationId: listGroupSsoConnectionUsers
      parameters:
      - description: The ID of the group
        in: path
        name: group_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/SsoId'
      - $ref: '#/components/parameters/StartingAfter'
      - $ref: '#/components/parameters/EndingBefore'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Version'
      responses:
        '200':
          content:
            application/vnd.api+json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/User'
                    type: array
                  jsonapi:
                    $ref: '#/components/schemas/JsonApi'
                  links:
                    $ref: '#/components/schemas/Links'
                required:
                - jsonapi
                - data
                - links
                type: object
          description: List of users is returned
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Get all users using a given SSO connection (Early Access)
      tags:
      - Groups
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2022-01-31~experimental
      - 2023-01-30~beta
      x-snyk-api-resource: groups
      x-snyk-api-stability: beta
      x-snyk-api-version: 2023-01-30~beta
      x-stability-level: beta
  /groups/{group_id}/sso_connections/{sso_id}/users/{user_id}:
    delete:
      description: 'Deletes a user from a Group SSO connection


        #### Required permissions


        - `View SSO settings (group.sso.read)`


        - `Delete users (group.user.delete)`'
      operationId: deleteUser
      parameters:
      - description: The ID of the group
        in: path
        name: group_id
        required: true
        schema:
          format: uuid
          type: string
      - $ref: '#/components/parameters/SsoId'
      - $ref: '#/components/parameters/UserId20230130'
      - $ref: '#/components/parameters/Version'
      responses:
        '204':
          description: User is deleted from Group SSO connection
          headers:
            deprecation:
              $ref: '#/components/headers/DeprecationHeader'
            snyk-request-id:
              $ref: '#/components/headers/RequestIdResponseHeader'
            snyk-version-lifecycle-stage:
              $ref: '#/components/headers/VersionStageResponseHeader'
            snyk-version-requested:
              $ref: '#/components/headers/VersionRequestedResponseHeader'
            snyk-version-served:
              $ref: '#/components/headers/VersionServedResponseHeader'
            sunset:
              $ref: '#/components/headers/SunsetHeader'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '500':
          $ref: '#/components/responses/500'
      summary: Delete a user from a Group SSO connection (Early Access)
      tags:
      - Groups
      x-snyk-api-lifecycle: released
      x-snyk-api-releases:
      - 2022-01-31~experimental
      - 2023-01-30~beta
      x-snyk-api-resource: groups
      x-snyk-api-stability: beta
      x-snyk-api-version: 2023-01-30~beta
      x-stability-level: beta
components:
  parameters:
    EndingBefore:
      description: Return the page of results immediately before this cursor
      example: v1.eyJpZCI6IjExMDAifQo=
      in: query
      name: ending_before
      schema:
        type: string
    IncludeGroupMembershipCount:
      description: indicates whether the count of group memberships is included
      in: query
      name: include_group_membership_count
      schema:
        type: boolean
    StartingAfter:
      description: Return the page of results immediately after this cursor
      example: v1.eyJpZCI6IjEwMDAifQo=
      in: query
      name: starting_after
      schema:
        type: string
    RoleFilter:
      description: Filter the response for results only with the specified role.
      in: query
      name: role_name
      schema:
        type: string
    Cascade:
      description: indicates whether to delete the child org memberships of the group membership.
      in: query
      name: cascade
      schema:
        type: boolean
    Version:
      description: The requested version of the endpoint to process the request
      example: '2026-03-25'
      in: query
      name: version
      required: true
      schema:
        $ref: '#/components/schemas/QueryVersion'
    Limit:
      description: Number of results to return per page
      example: 10
      in: query
      name: limit
      schema:
        default: 10
        format: int32
        maximum: 100
        minimum: 10
        multipleOf: 10
        type: integer
    SortBy__0:
      description: Which column to sort by.
      in: query
      name: sort_by
      schema:
        enum:
        - username
        - user_display_name
        - email
        - login_method
        - role_name
        type: string
    EmailFilter:
      description: Filter the response by Users that match the provided email
      in: query
      name: email
      schema:
        type: string
    UsernameFilter:
      description: Filter the response by Users that match the provided username
      in: query
      name: username
      schema:
        type: string
    SortOrder__0:
      description: Order in which results are returned.
      example: ASC
      in: query
      name: sort_order
      schema:
        default: DESC
        enum:
        - ASC
        - DESC
        type: string
    SsoId:
      description: The ID of the SSO
      in: path
      name: sso_id
      required: true
      schema:
        format: uuid
        type: string
    UserId20230130:
      description: The ID of the User
      in: path
      name: user_id
      required: true
      schema:
        format: uuid
        type: string
    OrgName:
      description: The Name of the org
      in: query
      name: org_name
      schema:
        description: Organization name
        example: Org name
        type: string
    UserIdFilter:
      description: Filter the response by Users that match the provided user ID
      in: query
      name: user_id
      schema:
        type: string
  schemas:
    GroupMembershipOrgMembershipUserData:
      properties:
        data:
          additionalProperties: false
          properties:
            attributes:
              properties:
                email:
                  description: The eamil of the user
                  example: user@test.com
                  type: string
                name:
                  description: The name of the user
                  example: User2
                  type: string
                username:
                  description: The username of the user
                  example: User name 2
                  type: string
              required:
              - name
              - username
              - email
              type: object
            id:
              example: 331ede0a-de94-456f-b788-166caeca58bf
              format: uuid
              type: string
            type:
              example: user
              type: string
          required:
          - id
          - attributes
          type: object
      type: object
    GroupMembershipGroupData:
      properties:
        data:
          additionalProperties: false
          properties:
            attributes:
              properties:
                name:
                  description: The name of the group
                  example: Example group
                  type: string
              required:
              - name
              type: object
            id:
              example: 331ede0a-de94-456f-b788-166caeca58bf
              format: uuid
              type: string
            type:
              example: group
              type: string
          required:
          - id
          - attributes
          type: object
      type: object
    ActualVersion:
      description: Resolved API version
      example: '2026-03-25'
      pattern: ^((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?)$
      type: string
    GroupMembershipOrgMembershipRelationships:
      additionalProperties: false
      properties:
        org:
          $ref: '#/components/schemas/GroupMembershipOrgMembershipOrgData'
        role:
          $ref: '#/components/schemas/GroupMembershipOrgMembershipRoleData'
        user:
          $ref: '#/components/schemas/GroupMembershipOrgMembershipUserData'
      required:
      - role
      - org
      - user
      type: object
    GroupMembershipMeta:
      additionalProperties: false
      properties:
        group_membership_count:
          type: number
      type: object
    JsonApi:
      additionalProperties: false
      example:
        version: '1.0'
      properties:
        version:
          description: Version of the JSON API specification this server supports.
          example: '1.0'
          pattern: ^(0|[1-9]\d*)\.(0|[1-9]\d*)$
          type: string
      required:
      - version
      type: object
    User:
      additionalProperties: false
      properties:
        attributes:
          additionalProperties: false
          properties:
            active:
              description: Whether the user status is enabled or not
              example: true
              type: boolean
            email:
              description: The email of the user.
              example: user@someorg.com
              type: string
            membership:
              properties:
                created_at:
                  description: The date the membership was established.
                  example: '2022-09-14T09:19:29.206Z'
                  format: date-time
                  type: string
                strategy:
                  description: Whether the membership is a direct, or indirect membership.
                  enum:
                  - direct
                  - indirect
                  example: direct
                  type: string
              type: object
            name:
              description: The name of the user.
              example: user
              type: string
            username:
              description: The username of the user.
              example: username
              type: string
          type: object
        id:
          description: The Snyk ID corresponding to this user
          example: 55a348e2-c3ad-4bbc-b40e-9b232d1f4121
          format: uuid
          type: string
        type:
          description: Content type.
          example: user
          type: string
      required:
      - type
      - id
      - attributes
      type: object
    GroupMembershipOrgMembership:
      additionalProperties: false
      properties:
        attributes:
          properties:
            created_at:
              description: The date that the org membership was created on
              example: '2021-05-29T09:50:54.014Z'
              format: date-time
          type: object
        id:
          example: 331ede0a-de94-456f-b788-166caeca58bf
          format: uuid
          type: string
        org_membership_count:
          description: Org memberships for this user within this group.
          type: number
        relationships:
          $ref: '#/components/schemas/GroupMembershipOrgMembershipRelationships'
        type:
          description: Content type.
          example: org_membership
          type: string
      required:
      - type
      - id
      - attributes
      - relationships
      type: object
    QueryVersion:
      description: Requested API version
      example: '2026-03-25'
      pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
      type: string
    SSOConnectionAttributes:
      additionalProperties: false
      properties:
        name:
          description: The display name of the sso connection.
          example: My SSO
          type: string
      required:
      - name
      type: object
    CreateGroupMembershipRequestBody:
      properties:
        data:
          additionalProperties: false
          properties:
            relationships:
              additionalProperties: false
              properties:
                group:
                  additionalProperties: false
                  properties:
                    data:
                      properties:
                        id:
                          example: 8aab168e-fb3b-47c0-9d87-442715788b31
                          format: uuid
                          type: string
                        type:
                          description: Always "group"
                          enum:
                          - group
                          example: group
                          type: string
                      type: object
                  type: object
                role:
                  additionalProperties: false
                  properties:
                    data:
                      properties:
                        id:
                          example: 331ede0a-de94-456f-b788-166caeca58bf
                          format: uuid
                          type: string
                        type:
                          description: Always "group_role"
                          enum:
                          - group_role
                          example: group_role
                          type: string
                      type: object
                  type: object
                user:
                  additionalProperties: false
                  properties:
                    data:
                      properties:
                        id:
                          example: 677d5f47-a8bf-4090-ba52-680903e7c8b5
                          format: uuid
                          type: string
                        type:
                          description: Always "user"
                          enum:
                          - user
                          example: user
                          type: string
                      type: object
                  type: object
         

# --- truncated at 32 KB (52 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/snyk/refs/heads/main/openapi/snyk-groups-api-openapi.yml
Snyk Groups API

Documentation

Specifications

Other Resources

OpenAPI Specification
