IAM

Before your application can access private data using other Workiva APIs, it must obtain an access token that grants access to those APIs.

BearerToken

Bearer token to use in subsequent requests to the Workiva APIs.

Properties

Name	Type	Description	Restrictions
access_token	string	The opaque string used to authorize and make requests on behalf of the user	required
expires_in	integer	The number of seconds the access token is valid	required
scope	string	The limits of the user’s access with the token, such as Read or Create	required
token_type	string	The type of access token; typically bearer	required

Example

{
  "access_token": "string",
  "expires_in": 0,
  "scope": "string",
  "token_type": "string"
}

IamError

Error response object containing an error code.

Properties

Name	Type	Description	Restrictions
error	string	The possible error codes are: - invalid_request - The request is missing a required parameter, includes an invalid parameter value, includes a parameter more than once, or is otherwise malformed. - unauthorized_client - The client is not authorized to request an authorization code using this method. - access_denied - The resource owner or authorization server denied the request. - unsupported_response_type - The authorization server does not support obtaining an authorization code using this method. - invalid_scope - The requested scope is invalid, unknown, or malformed. - server_error - The authorization server encountered an unexpected condition that prevented it from fulfilling the request. - temporarily_unavailable - The authorization server is currently unable to handle the request due to a temporary overloading or maintenance of the server.
error_description	string	Human-readable ASCII text providing additional information.
error_uri	string	A URI identifying a human-readable web page with information about the error.

Example

{
  "error": "string",
  "error_description": "string",
  "error_uri": "string"
}

Membership

A workspace membership held by the authenticated user, including the organization and workspace associated with the membership.

Properties

Name	Type	Description	Restrictions
id	string	The unique identifier of the workspace membership.	required
organization	object	The organization associated with the membership.	required
organization.id	string	The unique identifier of the organization.	required
organization.name	string	The name of the organization.	required
workspace	object	The workspace associated with the membership.	required
workspace.id	string	The unique identifier of the workspace.	required
workspace.name	string	The name of the workspace.	required

Example

{
  "id": "wm_0a8932e5302a4494950b9a4a2d46905c",
  "organization": {
    "id": "f4f8a26c-e062-4303-8460-bc57312a269a",
    "name": "APIs Testing"
  },
  "workspace": {
    "id": "QWNjb3VudB8xMTY5MjAyNTI4",
    "name": "APIs Admin Testing Workspace"
  }
}

MembershipCollection

A paginated collection of the workspace memberships held by the authenticated user.

Properties

Name	Type	Description	Restrictions
@nextLink	string	URL of the next page of results, with the $next cursor already applied. Omitted on the last page. Follow it to fetch the next page.
data	[Membership]	The workspace memberships held by the authenticated user that are returned in this response. This array contains only the current page of results.	required

Example

{
  "@nextLink": "https://api.app.wdesk.com/me/memberships?$next=b3BhcXVlLWN1cnNvci10b2tlbi05ZjhlN2Q=",
  "data": [
    {
      "id": "wm_0a8932e5302a4494950b9a4a2d46905c",
      "organization": {
        "id": "f4f8a26c-e062-4303-8460-bc57312a269a",
        "name": "APIs Testing"
      },
      "workspace": {
        "id": "QWNjb3VudB8xMTY5MjAyNTI4",
        "name": "APIs Admin Testing Workspace"
      }
    }
  ]
}