Admin

Endpoints to manage organizations, workspaces, groups, and users

BulkWorkspaceGroupMembersModification

Details about the group members modification

Properties

Name	Type	Description	Restrictions
toAdd	[string]¦null	The ids of the users to add as group members
toRemove	[string]¦null	The ids of the users to remove as group members

Example

{
  "toAdd": [
    "V0ZVc2VyHzExODjzNzM3NDA"
  ],
  "toRemove": [
    "V0ZVc2VyHzExSDkzMzM1NDC"
  ]
}

Organization

Details about the organization

Properties

Name	Type	Description	Restrictions
created	Action	When the action was performed, and details about the user who did it	read-only
id	string	The unique identifier of the organization	read-only
modified	Action	When the action was performed, and details about the user who did it	read-only
name	string	The name of the organization
status	string		read-only

Enumerated Values

Property	Value
status	active
status	inactive

Example

{
  "created": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "id": "d6e178fd-4dd5-47e5-9457-68dd64b03655",
  "modified": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "name": "Workiva Inc.",
  "status": "active"
}

OrganizationRole

Details describing a role in an organization

Properties

Name	Type	Description	Restrictions
id	string	The unique identifier of the organization role	read-only
name	string	The name of the organization role

Example

{
  "id": "3",
  "name": "Org User Admin"
}

OrganizationRolesListResult

Returns a JSON object with data and @nextLink properties. data contains a list of OrganizationRole objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[OrganizationRole]	Details describing a role in an organization	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "id": "3",
      "name": "Org User Admin"
    }
  ]
}

OrganizationRolesModification

An array of organization role ids used to modify organization roles

Properties

None

Example

[
  "3",
  "9"
]

OrganizationsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of Organization objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[Organization]	Details about the organization	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "created": {
        "dateTime": "2019-10-30T15:03:27Z",
        "user": {
          "displayName": "John Doe",
          "email": "string",
          "firstName": "John",
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
          "lastName": "Doe",
          "userName": "string"
        }
      },
      "id": "d6e178fd-4dd5-47e5-9457-68dd64b03655",
      "modified": {
        "dateTime": "2019-10-30T15:03:27Z",
        "user": {
          "displayName": "John Doe",
          "email": "string",
          "firstName": "John",
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
          "lastName": "Doe",
          "userName": "string"
        }
      },
      "name": "Workiva Inc.",
      "status": "active"
    }
  ]
}

OrganizationSolutionsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of Solution objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[Solution]	A set of capabilities available to an Organization	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "id": "60",
      "name": "Connected Global Statutory Reporting (with Entity Management)"
    }
  ]
}

OrganizationUserAction

When the action was performed, and details about the user who did it

Properties

Name	Type	Description	Restrictions
dateTime	string(date-time)¦null	When the action was performed	read-only
user	OrganizationUser¦null	The user’s ID

Example

{
  "dateTime": "2019-10-30T15:03:27Z",
  "user": {
    "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
  }
}

OrganizationUserAssignment

Details about a user assignment

Properties

Name	Type	Description	Restrictions
user	string	The id of the user to assign to the organization

Example

{
  "user": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
}

OrganizationUsersListResult

Returns a JSON object with data and @nextLink properties. data contains a list of OrganizationUser objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[OrganizationUser]	Details about the user.	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "created": {
        "dateTime": "2019-10-30T15:03:27Z",
        "user": null
      },
      "displayName": "John Doe",
      "email": "john.doe@example.com",
      "familyName": "Doe",
      "givenName": "John",
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
      "modified": {
        "dateTime": "2019-10-30T15:03:27Z",
        "user": null
      },
      "status": "active",
      "username": "john.doe@example.com"
    }
  ]
}

PlatformUser

Details about the user, including their name, ID, and email address

Properties

Name	Type	Description	Restrictions
displayName	string	Display name of the user	read-only
email	string	Email address of the user	read-only
firstName	string	First name of the user	read-only
id	string	The unique identifier of the user
lastName	string	Last name of the user	read-only
userName	string	Username of the user	read-only

Example

{
  "displayName": "John Doe",
  "email": "string",
  "firstName": "John",
  "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
  "lastName": "Doe",
  "userName": "string"
}

Solution

A set of capabilities available to an Organization

Properties

Name	Type	Description	Restrictions
id	string	The unique identifier for the Solution
name	string	The name of the Solution

Example

{
  "id": "60",
  "name": "Connected Global Statutory Reporting (with Entity Management)"
}

Workspace

Details about a workspace

Properties

Name	Type	Description	Restrictions
created	Action	When the action was performed, and details about the user who did it	read-only
id	string	The unique identifier of the workspace	read-only
modified	Action	When the action was performed, and details about the user who did it	read-only
name	string	The name of the workspace
organization	Organization	The organization that this workspace belongs to	read-only
solutions	[Solution]	A set of capabilities available to an Organization	Maximum items: 1

Example

{
  "created": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "id": "QWNjb3VudB81NjM5NDQ1NjA0NzI4ODMy",
  "modified": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "name": "Quarterly Planning",
  "organization": {
    "id": "d6e178fd-4dd5-47e5-9457-68dd64b03655",
    "name": "Workiva Inc."
  },
  "solutions": [
    {
      "id": "60",
      "name": "Connected Global Statutory Reporting (with Entity Management)"
    }
  ]
}

WorkspaceGroup

Details about the group

Properties

Name	Type	Description	Restrictions
created	Action	When the action was performed, and details about the user who did it	read-only
id	string	The unique identifier of the group	read-only
memberCount	integer	Number of members in the group	read-only
members	[WorkspaceGroupMember]	IDs of the group members. Included in the response only when the $expand query parameter is provided.	read-only
modified	Action	When the action was performed, and details about the user who did it	read-only
name	string	The name of the group

Example

{
  "created": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "id": "V0ZHcm91cB5XRkdyb3VwOkFMTF9VU0VSUznxMjD1NTVyNDg3",
  "memberCount": 153,
  "members": [
    {
      "id": "V0ZVc2VyHzExODkzNzM2NDB"
    }
  ],
  "modified": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "name": "All Users"
}

WorkspaceGroupMember

Details about the group member

Properties

Name	Type	Description	Restrictions
id	string	The unique identifier of the group member	read-only

Example

{
  "id": "V0ZVc2VyHzExODkzNzM2NDB"
}

WorkspaceGroupMembersListResult

Returns a JSON object with data and @nextLink properties. data contains a list of WorkspaceGroupMember objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[WorkspaceGroupMember]	Details about the group member	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "id": "V0ZVc2VyHzExODkzNzM2NDB"
    }
  ]
}

WorkspaceGroupsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of WorkspaceGroup objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[WorkspaceGroup]	Details about the group	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "created": {
        "dateTime": "2019-10-30T15:03:27Z",
        "user": {
          "displayName": "John Doe",
          "email": "string",
          "firstName": "John",
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
          "lastName": "Doe",
          "userName": "string"
        }
      },
      "id": "V0ZHcm91cB5XRkdyb3VwOkFMTF9VU0VSUznxMjD1NTVyNDg3",
      "memberCount": 153,
      "members": [
        {
          "id": "V0ZVc2VyHzExODkzNzM2NDB"
        }
      ],
      "modified": {
        "dateTime": "2019-10-30T15:03:27Z",
        "user": {
          "displayName": "John Doe",
          "email": "string",
          "firstName": "John",
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
          "lastName": "Doe",
          "userName": "string"
        }
      },
      "name": "All Users"
    }
  ]
}

WorkspaceMembership

Details about a user’s membership in a workspace.

Properties

Name	Type	Description	Restrictions
created	OrganizationUserAction	When the action was performed, and details about the user who did it	read-only
id	string	The unique identifier of the workspace membership	read-only
modified	OrganizationUserAction	When the action was performed, and details about the user who did it	read-only
user	OrganizationUser	The user that is a member of the workspace
workspace	Workspace	The workspace that this membership belongs to

Example

{
  "created": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "id": "TWVtYmVyc2hpcB81NzY1OTM4MzY0Mjg0OTI4",
  "modified": {
    "dateTime": "2019-10-30T15:03:27Z",
    "user": {
      "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
    }
  },
  "user": {
    "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
  },
  "workspace": {
    "id": "QWNjb3VudB81NjM5NDQ1NjA0NzI4ODMy"
  }
}

WorkspaceMembershipCreation

Details and Options for creating a new workspace membership.

Properties

Name	Type	Description	Restrictions
options	WorkspaceMembershipCreationOptions	Options for creating a new workspace membership
user	string	The user id that will be made a member of the workspace.

Example

{
  "options": {
    "notifyNewMember": false,
    "sendWelcomeEmail": true
  },
  "user": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD"
}

WorkspaceMembershipCreationOptions

Options for creating a new workspace membership

Properties

Name	Type	Description	Restrictions
notifyNewMember	boolean	Whether or not a notification should be sent to the user when they are added to the workspace. False by default.
sendWelcomeEmail	boolean	Whether or not a welcome email should be sent to the user when they are added to the workspace. False by default.

Example

{
  "notifyNewMember": false,
  "sendWelcomeEmail": true
}

WorkspaceMembershipRole

Details describing a role of a workspace member

Properties

Name	Type	Description	Restrictions
id	string	The unique identifier of the workspace membership role	read-only
name	string	The name of the workspace membership role

Example

{
  "id": "2",
  "name": "Workspace Owner"
}

WorkspaceMembershipRolesListResult

Returns a JSON object with data and @nextLink properties. data contains a list of WorkspaceMembershipRole objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[WorkspaceMembershipRole]	Details describing a role of a workspace member	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "id": "2",
      "name": "Workspace Owner"
    }
  ]
}

WorkspaceMembershipsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of WorkspaceMembership objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[WorkspaceMembership]	Details about a user’s membership in a workspace.	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "created": {
        "dateTime": "2019-10-30T15:03:27Z",
        "user": {
          "created": null,
          "displayName": "John Doe",
          "email": "john.doe@example.com",
          "familyName": "Doe",
          "givenName": "John",
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
          "modified": null,
          "status": "active",
          "username": "john.doe@example.com"
        }
      },
      "id": "TWVtYmVyc2hpcB81NzY1OTM4MzY0Mjg0OTI4",
      "modified": {
        "dateTime": "2019-10-30T15:03:27Z",
        "user": {
          "created": null,
          "displayName": "John Doe",
          "email": "john.doe@example.com",
          "familyName": "Doe",
          "givenName": "John",
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
          "modified": null,
          "status": "active",
          "username": "john.doe@example.com"
        }
      },
      "user": {
        "created": null,
        "displayName": "John Doe",
        "email": "john.doe@example.com",
        "familyName": "Doe",
        "givenName": "John",
        "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
        "modified": null,
        "status": "active",
        "username": "john.doe@example.com"
      },
      "workspace": {
        "created": {
          "dateTime": "2019-10-30T15:03:27Z",
          "user": {
            "displayName": "John Doe",
            "email": "string",
            "firstName": "John",
            "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
            "lastName": "Doe",
            "userName": "string"
          }
        },
        "id": "QWNjb3VudB81NjM5NDQ1NjA0NzI4ODMy",
        "modified": {
          "dateTime": "2019-10-30T15:03:27Z",
          "user": {
            "displayName": "John Doe",
            "email": "string",
            "firstName": "John",
            "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
            "lastName": "Doe",
            "userName": "string"
          }
        },
        "name": "Quarterly Planning",
        "organization": {
          "created": {
            "dateTime": "2019-10-30T15:03:27Z",
            "user": {
              "displayName": "John Doe",
              "email": "string",
              "firstName": "John",
              "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
              "lastName": "Doe",
              "userName": "string"
            }
          },
          "id": "d6e178fd-4dd5-47e5-9457-68dd64b03655",
          "modified": {
            "dateTime": "2019-10-30T15:03:27Z",
            "user": {
              "displayName": "John Doe",
              "email": "string",
              "firstName": "John",
              "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
              "lastName": "Doe",
              "userName": "string"
            }
          },
          "name": "Workiva Inc.",
          "status": "active"
        },
        "solutions": [
          {
            "id": "60",
            "name": "Connected Global Statutory Reporting (with Entity Management)"
          }
        ]
      }
    }
  ]
}

WorkspaceRole

Details describing a role in a workspace

Properties

Name	Type	Description	Restrictions
id	string	The unique identifier of the workspace role	read-only
name	string	The name of the workspace role

Example

{
  "id": "2",
  "name": "Workspace Owner"
}

WorkspaceRolesListResult

Returns a JSON object with data and @nextLink properties. data contains a list of WorkspaceRole objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[WorkspaceRole]	Details describing a role in a workspace	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "id": "2",
      "name": "Workspace Owner"
    }
  ]
}

WorkspaceRolesModification

An array of workspace role ids used to modify workspace roles

Properties

None

Example

[
  "string"
]

WorkspacesListResult

Returns a JSON object with data and @nextLink properties. data contains a list of Workspace objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[Workspace]	Details about a workspace	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "created": {
        "dateTime": "2019-10-30T15:03:27Z",
        "user": {
          "displayName": "John Doe",
          "email": "string",
          "firstName": "John",
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
          "lastName": "Doe",
          "userName": "string"
        }
      },
      "id": "QWNjb3VudB81NjM5NDQ1NjA0NzI4ODMy",
      "modified": {
        "dateTime": "2019-10-30T15:03:27Z",
        "user": {
          "displayName": "John Doe",
          "email": "string",
          "firstName": "John",
          "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
          "lastName": "Doe",
          "userName": "string"
        }
      },
      "name": "Quarterly Planning",
      "organization": {
        "created": {
          "dateTime": "2019-10-30T15:03:27Z",
          "user": {
            "displayName": "John Doe",
            "email": "string",
            "firstName": "John",
            "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
            "lastName": "Doe",
            "userName": "string"
          }
        },
        "id": "d6e178fd-4dd5-47e5-9457-68dd64b03655",
        "modified": {
          "dateTime": "2019-10-30T15:03:27Z",
          "user": {
            "displayName": "John Doe",
            "email": "string",
            "firstName": "John",
            "id": "V1ZVd2VyFzU3NiQ1NDA4NjIzNzk2MjD",
            "lastName": "Doe",
            "userName": "string"
          }
        },
        "name": "Workiva Inc.",
        "status": "active"
      },
      "solutions": [
        {
          "id": "60",
          "name": "Connected Global Statutory Reporting (with Entity Management)"
        }
      ]
    }
  ]
}

WorkspaceSolutionsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of Solution objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[Solution]	A set of capabilities available to an Organization	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "id": "60",
      "name": "Connected Global Statutory Reporting (with Entity Management)"
    }
  ]
}