Zywave Agency User API

openapi: 3.2.0
info:
  title: Agencies API v2.0 Agency User API
  version: v2.0
servers:
- url: https://api.zywave.com
security:
- oidc:
  - api.agencies
  - api.agencies:read
tags:
- name: AgencyUser
paths:
  /agencies/v2.0/agencyuser:
    get:
      tags:
      - AgencyUser
      summary: Searches for agency users
      description: See Zywave API search documentation for details.
      operationId: AgencyUser_GetAgencyUsers
      parameters:
      - name: $filter
        in: query
        description: The filter used to find the desired agency users
        schema:
          type:
          - string
          - 'null'
        x-position: 1
      - name: $orderBy
        in: query
        description: The properties used to order the search results
        schema:
          type:
          - string
          - 'null'
        x-position: 2
      - name: $skip
        in: query
        description: The number of records in the result set to skip
        schema:
          type: integer
          format: int32
          default: 0
        x-position: 3
      - name: $top
        in: query
        description: The maximum number of records after the first skip records to take from the remaining result set
        schema:
          type: integer
          format: int32
          default: 0
        x-position: 4
      responses:
        '200':
          description: The agency users that the profile identity is permitted to view.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResultOfAgencyUser'
        '400':
          description: ''
          content:
            application/json:
              schema:
                type: string
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    post:
      tags:
      - AgencyUser
      summary: Creates an agency user
      operationId: AgencyUser_PostAgencyUser
      parameters:
      - name: sendEmail
        in: query
        description: A value indicating whether to send an activation email to the new user (default is false).
        schema:
          type: boolean
          default: false
        x-position: 2
      requestBody:
        x-name: agencyUserInfo
        description: Information for the user to be created.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgencyUserInfo'
        required: true
        x-position: 1
      responses:
        '201':
          description: The ID of the created user.
          content:
            application/json:
              schema:
                type: integer
                format: int32
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /agencies/v2.0/agencyuser/{id}:
    get:
      tags:
      - AgencyUser
      summary: Returns agency user profile information for the agency user ID sent in the…
      operationId: AgencyUser_GetAgencyUser
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the agency user
        schema:
          type: integer
          format: int32
        x-position: 1
      responses:
        '200':
          description: The desired agency user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgencyUser'
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - AgencyUser
      summary: Updates an existing agency user
      operationId: AgencyUser_PutAgencyUser
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the agency user to update
        schema:
          type: integer
          format: int32
        x-position: 1
      requestBody:
        x-name: agencyUserInfo
        description: The information to update on the agency user.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AgencyUserInfo'
        required: true
        x-position: 2
      responses:
        '204':
          description: ''
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    delete:
      tags:
      - AgencyUser
      summary: Deletes the agency user associated with the agency user ID
      operationId: AgencyUser_DeleteAgencyUser
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the agency user to delete.
        schema:
          type: integer
          format: int32
        x-position: 1
      responses:
        '204':
          description: ''
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
  /agencies/v2.0/agencyuser/{agencyUserId}/group:
    get:
      tags:
      - AgencyUser
      summary: Returns groupId's associated with the agency user ID sent in the request
      operationId: AgencyUser_GetAgencyUserGroups
      parameters:
      - name: agencyUserId
        in: path
        required: true
        description: The ID of the agency user
        schema:
          type: integer
          format: int32
        x-position: 1
      responses:
        '200':
          description: The groupId's the agency user belongs to.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: integer
                  format: int32
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
    put:
      tags:
      - AgencyUser
      summary: Updates the groups associated with the agency user Id in the request
      operationId: AgencyUser_PutAgencyUserGroups
      parameters:
      - name: agencyUserId
        in: path
        required: true
        description: The ID of the agency user
        schema:
          type: integer
          format: int32
        x-position: 1
      requestBody:
        x-name: groupIds
        description: The group IDs to be associated with the agency user
        content:
          application/json:
            schema:
              type: array
              items:
                type:
                - integer
                - 'null'
                format: int32
        required: true
        x-position: 2
      responses:
        '204':
          description: ''
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
components:
  schemas:
    ProblemDetails:
      type: object
      additionalProperties: {}
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
    AgencyUserRole:
      type: string
      description: ''
      x-enumNames:
      - None
      - Executive
      - Sales
      - ClientServices
      - InformationTechnology
      - Finance
      - HumanResources
      enum:
      - None
      - Executive
      - Sales
      - ClientServices
      - InformationTechnology
      - Finance
      - HumanResources
    PagedResultOfAgencyUser:
      type: object
      additionalProperties: false
      properties:
        hasMoreResults:
          type: boolean
          description: A value indicating whether the larger result set has more results.
        pageIndex:
          type:
          - integer
          - 'null'
          description: The index of the page reflected by the collection.
          format: int32
        pageSize:
          type:
          - integer
          - 'null'
          description: The size of the page reflected by the collection.
          format: int32
        skip:
          type: integer
          description: A value indicating how many of the previous values in the larger result set were omitted.
          format: int32
        take:
          type: integer
          description: The number of records retrieved from larger result set.
          format: int32
        totalCount:
          type: integer
          description: The total number of records in the larger result set.
          format: int32
        items:
          type: array
          description: The records retrieved from the larger result set.
          items:
            $ref: '#/components/schemas/AgencyUser'
    AgencyUser:
      allOf:
      - $ref: '#/components/schemas/AgencyUserInfo'
      - type: object
        description: Within the Zywave platform someone may have a number of user profiles tied to their login. When that user profile is associated with a tenant that is an agency within the Zywave platform that is called an agency user.
        additionalProperties: false
        properties:
          id:
            type: integer
            description: The unique Zywave identifier for the user at the agency.
            format: int32
          agencyId:
            type: integer
            description: The ID for the agency associated with this user.
            format: int32
          createdDateTime:
            type:
            - string
            - 'null'
            description: The datetime in which an AgencyUser was created.
            format: date-time
          createdUserPrincipalId:
            type:
            - string
            - 'null'
            description: The user principal Id of the user who created the new AgencyUser.
            format: guid
          updatedDateTime:
            type:
            - string
            - 'null'
            description: The datetime in which an AgencyUser was updated.
            format: date-time
          updatedUserPrincipalId:
            type:
            - string
            - 'null'
            description: The user principal Id of the user who updated the new AgencyUser.
            format: guid
    AgencyUserInfo:
      type: object
      description: AgencyUserInfo represents the editable properties of an agency user.
      additionalProperties: false
      required:
      - firstName
      - lastName
      properties:
        biography:
          type:
          - string
          - 'null'
          description: A written biography about the user.
          maxLength: 1000
        designation:
          type:
          - string
          - 'null'
          description: A list of professional designations earned by the user.
          maxLength: 50
        emailAddress:
          type:
          - string
          - 'null'
          description: The primary emails address of the user.
          maxLength: 100
        externalEmployeeId:
          type:
          - string
          - 'null'
          description: An identifier for correlation with an external employee management system
          maxLength: 50
        faxNumber:
          type:
          - string
          - 'null'
          description: The primary fax number of the user.
          maxLength: 20
        firstName:
          type: string
          description: The first name of the user.
          maxLength: 50
          minLength: 1
        isAdministrator:
          type: boolean
          description: Denotes whether the user has full administrative privileges for the specific agency the are associated with.
        isEnabled:
          type: boolean
          description: Determine whether the user is an active user.  If the user is not active they will not have access to the Zywave platform for the specific agency they are associated with.
        lastName:
          type: string
          description: The last name of the user.
          maxLength: 50
          minLength: 1
        linesOfBusiness:
          type: array
          description: Specifies the lines of business within the agency the user is associated with.
          items:
            $ref: '#/components/schemas/LineOfBusiness'
        middleInitial:
          type:
          - string
          - 'null'
          description: The middle initial of the user.
          maxLength: 2
        npn:
          type:
          - string
          - 'null'
          description: The national produce number for the user at this agency.
          maxLength: 10
        phoneNumber:
          type:
          - string
          - 'null'
          description: The primary phone number of the user.
          maxLength: 20
        primaryRole:
          description: The primary role of the user at the agency.
          oneOf:
          - $ref: '#/components/schemas/AgencyUserRole'
        salutation:
          type:
          - string
          - 'null'
          description: The greeting associated with the user.
          maxLength: 8
        title:
          type:
          - string
          - 'null'
          description: The job title of the user at the agency.
          maxLength: 100
    LineOfBusiness:
      type: string
      description: ''
      x-enumNames:
      - None
      - Benefits
      - Financial
      - PersonalLines
      - PropertyCasualty
      enum:
      - None
      - Benefits
      - Financial
      - PersonalLines
      - PropertyCasualty
  securitySchemes:
    oidc:
      type: openIdConnect
      openIdConnectUrl: https://auth.zywave.com/.well-known/openid-configuration
x-generator: NSwag v14.7.1.0 (NJsonSchema v11.6.1.0 (Newtonsoft.Json v13.0.0.0))