Zywave

Zywave User Principal API

The UserPrincipal API from Zywave — 2 operation(s) for userprincipal.

Documentation GitHub OpenAPI

Operations 2

GET /v3/orgs/v1.0/org/{organizationId}/userprincipal/{id} Get orgs org by organization id userprincipal by id #

GET /v3/orgs/v1.0/org/{organizationId}/userprincipal Get orgs org by organization id userprincipal #

Documentation

https://www.zywave.dev/apis/

Specifications

https://artifacts.apis.io/zywave/openapi/zywave-userprincipal-api-openapi.yml

Schemas & Data

https://artifacts.apis.io/zywave/json-schema/zywave-account-contact-info-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-account-info-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-account-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-account-contact-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-account-external-reference-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-account-contact-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-account-contact-driver-info-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-account-contact-driver-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-agency-user-info-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-agency-user-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-agency-user-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-agency-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-agency-collection-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-activity-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-carrier-contact-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-commission-schedule-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-broker-contact-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-plan-rate-metadata-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-file-response-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-carrier-company-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-carrier-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-carrier-company-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-carrier-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-invite-request-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-employee-response-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-tool-package-response-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-employee-request-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-tool-package-request-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-employee-group-response-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-company-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-loss-event-details-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-company-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-program-assessment-search-request-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-loss-event-data-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-rpm-data-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-download-request-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-content-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-content-aggregation-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-content-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-recommended-content-info-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-file-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-welfare-summary-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-commercial-details-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-commercial-summary-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-company-contacts-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-company-details-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-feature-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-license-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-feature-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-license-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-feature-license-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-user-principal-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-paged-result-of-user-principal-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-quote-info-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-refresh-quote-request-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-plan-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-search-result-of-quoted-plan-with-member-rates-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-search-result-of-coverage-group-quoted-plan-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-search-result-of-plan-with-rates-schema.json

https://artifacts.apis.io/zywave/json-schema/zywave-policy-info-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/zywave:zywave-userprincipal-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Organizations API v1.0 User Principal API
  version: v1.0
servers:
- url: https://api.zywave.com
tags:
- name: UserPrincipal
paths:
  /v3/orgs/v1.0/org/{organizationId}/userprincipal/{id}:
    get:
      tags:
      - UserPrincipal
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPrincipal'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Get orgs org by organization id userprincipal by id
      x-summary-source: derived
      operationId: getV3OrgsV10OrgByOrganizationIdUserprincipalById
      x-operation-id-source: derived
  /v3/orgs/v1.0/org/{organizationId}/userprincipal:
    get:
      tags:
      - UserPrincipal
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $filter
        in: query
        schema:
          type: string
          default: null
      - name: $orderBy
        in: query
        schema:
          type: string
          default: null
      - name: $skip
        in: query
        schema:
          type: integer
          format: int32
          default: 0
      - name: $top
        in: query
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedResultOfUserPrincipal'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationProblemDetails'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Get orgs org by organization id userprincipal
      x-summary-source: derived
      operationId: getV3OrgsV10OrgByOrganizationIdUserprincipal
      x-operation-id-source: derived
components:
  schemas:
    UserPrincipal:
      required:
      - userPrincipalName
      type: object
      properties:
        id:
          type: string
          format: uuid
        expirationDateTime:
          type:
          - string
          - 'null'
          format: date-time
        givenName:
          type:
          - string
          - 'null'
        isEnabled:
          type: boolean
        isPasswordChangeRequired:
          type: boolean
        surname:
          type:
          - string
          - 'null'
        userPrincipalName:
          type: string
    PagedResultOfUserPrincipal:
      type: object
      properties:
        hasMoreResults:
          type: boolean
        skip:
          type: integer
          format: int32
        take:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
        items:
          type: array
          items:
            $ref: '#/components/schemas/UserPrincipal'
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
    ValidationProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string