---

title: Organizations API v1.0 language_tabs:

• shell: Shell
• http: HTTP
• javascript: JavaScript
• javascript--nodejs: Node.JS
• ruby: Ruby
• python: Python
• java: Java
• go: Go toc_footers: [] includes: [] search: false highlight_theme: darkula headingLevel: 2

---

Organizations API v1.0 v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

• https://api.zywave.com

UserPrincipal

get__v3_orgs_v1.0_org_{organizationId}userprincipal{id}

GET /v3/orgs/v1.0/org/{organizationId}/userprincipal/{id}

Parameters

Name	In	Type	Required	Description
id	path	string(uuid)	true	none
organizationId	path	string(uuid)	true	none

Example responses

200 Response

{
  "required": [
    "userPrincipalName"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "expirationDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "givenName": {
      "type": "string",
      "nullable": true
    },
    "isEnabled": {
      "type": "boolean"
    },
    "isPasswordChangeRequired": {
      "type": "boolean"
    },
    "surname": {
      "type": "string",
      "nullable": true
    },
    "userPrincipalName": {
      "type": "string"
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	UserPrincipal
401	Unauthorized	Unauthorized	ProblemDetails
404	Not Found	Not Found	ProblemDetails

get__v3_orgs_v1.0_org_{organizationId}_userprincipal

GET /v3/orgs/v1.0/org/{organizationId}/userprincipal

Parameters

Name	In	Type	Required	Description
organizationId	path	string(uuid)	true	none
$filter	query	string	false	none
$orderBy	query	string	false	none
$skip	query	integer(int32)	false	none
$top	query	integer(int32)	false	none

Example responses

200 Response

{
  "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": {
        "required": [
          "userPrincipalName"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "expirationDateTime": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "givenName": {
            "type": "string",
            "nullable": true
          },
          "isEnabled": {
            "type": "boolean"
          },
          "isPasswordChangeRequired": {
            "type": "boolean"
          },
          "surname": {
            "type": "string",
            "nullable": true
          },
          "userPrincipalName": {
            "type": "string"
          }
        }
      }
    }
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PagedResultOfUserPrincipal
400	Bad Request	Bad Request	ValidationProblemDetails
401	Unauthorized	Unauthorized	ProblemDetails

Schemas

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": {
        "required": [
          "userPrincipalName"
        ],
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid"
          },
          "expirationDateTime": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "givenName": {
            "type": "string",
            "nullable": true
          },
          "isEnabled": {
            "type": "boolean"
          },
          "isPasswordChangeRequired": {
            "type": "boolean"
          },
          "surname": {
            "type": "string",
            "nullable": true
          },
          "userPrincipalName": {
            "type": "string"
          }
        }
      }
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
hasMoreResults	boolean	false	none	none
skip	integer(int32)	false	none	none
take	integer(int32)	false	none	none
totalCount	integer(int32)	false	none	none
items	[UserPrincipal]	false	none	none

ProblemDetails

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "nullable": true
    },
    "title": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "detail": {
      "type": "string",
      "nullable": true
    },
    "instance": {
      "type": "string",
      "nullable": true
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
type	string|null	false	none	none
title	string|null	false	none	none
status	integer(int32)|null	false	none	none
detail	string|null	false	none	none
instance	string|null	false	none	none

UserPrincipal

{
  "required": [
    "userPrincipalName"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "expirationDateTime": {
      "type": "string",
      "format": "date-time",
      "nullable": true
    },
    "givenName": {
      "type": "string",
      "nullable": true
    },
    "isEnabled": {
      "type": "boolean"
    },
    "isPasswordChangeRequired": {
      "type": "boolean"
    },
    "surname": {
      "type": "string",
      "nullable": true
    },
    "userPrincipalName": {
      "type": "string"
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	string(uuid)	false	none	none
expirationDateTime	string(date-time)|null	false	none	none
givenName	string|null	false	none	none
isEnabled	boolean	false	none	none
isPasswordChangeRequired	boolean	false	none	none
surname	string|null	false	none	none
userPrincipalName	string	true	none	none

ValidationProblemDetails

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "nullable": true
    },
    "title": {
      "type": "string",
      "nullable": true
    },
    "status": {
      "type": "integer",
      "format": "int32",
      "nullable": true
    },
    "detail": {
      "type": "string",
      "nullable": true
    },
    "instance": {
      "type": "string",
      "nullable": true
    },
    "errors": {
      "type": "object",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  }
}

Properties

Name	Type	Required	Restrictions	Description
type	string|null	false	none	none
title	string|null	false	none	none
status	integer(int32)|null	false	none	none
detail	string|null	false	none	none
instance	string|null	false	none	none
errors	object	false	none	none
» additionalProperties	[string]	false	none	none