Talend SCIM 2.0 Resource Type API

openapi: 3.2.0
info:
  title: SCIM v2 SCIM 2.0 Resource Type API
  description: Manage your users and groups using SCIM 2.0.
  contact:
    name: Talend Support
  license:
    name: Apache License Version 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.txt
  version: 2021-03
servers:
- url: https://api.eu.cloud.talend.com
  description: URL for the AWS Europe region
  x-talend:
    isPublished: true
- url: https://api.ap.cloud.talend.com
  description: URL for the AWS Asia Pacific region
  x-talend:
    isPublished: true
- url: https://api.us.cloud.talend.com
  description: URL for the AWS United States East region
  x-talend:
    isPublished: true
- url: https://api.au.cloud.talend.com
  description: URL for the AWS Australia region
  x-talend:
    isPublished: true
- url: https://api.us-west.cloud.talend.com
  description: URL for the Azure United States West region
  x-talend:
    isPublished: true
security:
- Public: []
tags:
- name: SCIM 2.0 Resource Type
paths:
  /scim/v2/ResourceTypes:
    summary: Resource types
    description: Endpoint used to discover the types of resources available.
    x-talend:
      section: Discovery
    get:
      tags:
      - SCIM 2.0 Resource Type
      summary: Get Talend resource types
      description: Talend currently supports resources users, groups and roles.
      operationId: search_4
      parameters:
      - name: filter
        in: query
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ListResponseGenericScimResource'
  /scim/v2/ResourceTypes/{id}:
    summary: Resource type
    description: Endpoint used to get detail about a specific resource type.
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    x-talend:
      section: Discovery
    get:
      tags:
      - SCIM 2.0 Resource Type
      summary: Get Talend specific resource type
      description: Talend currently supports resources users, groups and roles.
      operationId: get_5
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ScimResource'
components:
  schemas:
    Meta:
      type: object
      properties:
        resourceType:
          type: string
        created:
          type: string
          format: date-time
        lastModified:
          type: string
          format: date-time
        location:
          type: string
        version:
          type: string
      x-talend:
        section: Common
    GenericScimResource:
      type: object
      properties:
        objectNode:
          type: object
        id:
          type: string
        meta:
          $ref: '#/components/schemas/Meta'
        externalId:
          type: string
        schemaUrns:
          type: array
          items:
            type: string
      x-talend:
        section: Common
    ScimResource:
      type: object
      properties:
        id:
          type: string
        meta:
          $ref: '#/components/schemas/Meta'
        externalId:
          type: string
        schemaUrns:
          type: array
          items:
            type: string
      x-talend:
        section: Common
    ListResponseGenericScimResource:
      type: object
      required:
      - Resources
      - totalResults
      properties:
        schemas:
          type: array
          items:
            type: string
          uniqueItems: true
        id:
          type: string
        externalId:
          type: string
        meta:
          $ref: '#/components/schemas/Meta'
        totalResults:
          type: integer
          format: int64
        Resources:
          type: array
          items:
            $ref: '#/components/schemas/GenericScimResource'
        startIndex:
          type: integer
          format: int32
        itemsPerPage:
          type: integer
          format: int32
      x-talend:
        section: Common
  securitySchemes:
    Public:
      type: http
      scheme: bearer
      bearerFormat: Bearer <TOKEN>
x-talend:
  sections:
    Discovery: {}
    Users:
      description: "As you might expect, users map to the individuals of your account (domain). Each user contains properties called attributes. You can list users, filter by attribute, add new users, update a user's profile information, or remove a user entirely.\n\nAttributes are the details associated with a user's account. These are the details that someone would typically set in their profile. The following table maps SCIM attributes with Talend Cloud user attributes:\n\n| Talend user field | SCIM attribute | Attribute type |Required|\n| -------- | -------- | -------- | -------- |\n| login     | userName     | Singular     | **Required** |\n| firstName     | name.givenName     | Singular     | **Required** |\n| middleName     | name.middleName     | Singular     | |\n| lastName     | name.familyName     | Singular     | **Required** |\n| email     | \temails\\[primary=true\\].value     | Multi-Valued     | |\n| phone     | phoneNumbers\\[type='work'\\].value     | Multi-Valued     | |\n| active     | active     | Singular     | |\n| password     | password     | Singular     | |\n| title     | title     | Singular     | |\n| preferredLanguage     | preferredLanguage     | Singular   |   |\n| timezone     | timezone     | Singular     | |\n| groups     | groups     | Multi-Valued     | |\n| roles     | roles     | Multi-Valued     | |\n\nRequires the permission **Users - Manage** (**TMC_USER_MANAGEMENT**)."
    Groups:
      description: 'Groups map to Talend groups with the following attributes:

        | Talend user field | SCIM attribute | Attribute type |Required|

        | -------- | -------- | -------- | -------- |

        | name     | displayName     | Singular     | **Required** |

        | userIds     | members.value     | Multi-Valued     | |


        Requires the permission **Groups - Manage** (**TMC_GROUP_MANAGEMENT**).'
    Roles:
      description: 'Roles map to Talend roles with the following attributes:

        | Talend user field | SCIM attribute | Attribute type |Required|

        | -------- | -------- | -------- | -------- |

        | name     | name     | Singular     | **Required** |

        | permissions     | entitlements     | Multi-Valued     | **Required**|


        Requires the permission **Roles - Manage** (**TMC_ROLE_MANAGEMENT**).'
    Common: {}