Skip to content

AccessRequestsApi.md

Latest commit

 

History

History
184 lines (122 loc) · 5.61 KB

AccessRequestsApi.md

File metadata and controls

184 lines (122 loc) · 5.61 KB

Asana.AccessRequestsApi

All URIs are relative to https://app.asana.com/api/1.0

Method HTTP request Description
approveAccessRequest POST /access_requests/{access_request_gid}/approve Approve an access request
createAccessRequest POST /access_requests Create an access request
getAccessRequests GET /access_requests Get access requests
rejectAccessRequest POST /access_requests/{access_request_gid}/reject Reject an access request

approveAccessRequest

Approve an access request

Approves an access request for a target object.

(more information)

Example

const Asana = require('asana');

let client = new Asana.ApiClient();
client.authentications.token.accessToken = '<YOUR_ACCESS_TOKEN>';

let accessRequestsApiInstance = new Asana.AccessRequestsApi(client);
let access_request_gid = "12345"; // String | Globally unique identifier for the access request.

accessRequestsApiInstance.approveAccessRequest(access_request_gid).then((result) => {
    console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2));
}, (error) => {
    console.error(error.response.body);
});

Parameters

Name Type Description Notes
access_request_gid String Globally unique identifier for the access request.

Return type

object

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=UTF-8

createAccessRequest

Create an access request

Submits a new access request for a private object. Currently supports projects and portfolios.

(more information)

Example

const Asana = require('asana');

let client = new Asana.ApiClient();
client.authentications.token.accessToken = '<YOUR_ACCESS_TOKEN>';

let accessRequestsApiInstance = new Asana.AccessRequestsApi(client);
let body = {"data": {"<PARAM_1>": "<VALUE_1>", "<PARAM_2>": "<VALUE_2>",}}; // Object | 

accessRequestsApiInstance.createAccessRequest(body).then((result) => {
    console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2));
}, (error) => {
    console.error(error.response.body);
});

Parameters

Name Type Description Notes
body Object

Return type

object

HTTP request headers

  • Content-Type: application/json; charset=UTF-8
  • Accept: application/json; charset=UTF-8

getAccessRequests

Get access requests

Returns the pending access requests for a target object or a target object filtered by user.

(more information)

Example

const Asana = require('asana');

let client = new Asana.ApiClient();
client.authentications.token.accessToken = '<YOUR_ACCESS_TOKEN>';

let accessRequestsApiInstance = new Asana.AccessRequestsApi(client);
let target = "1331"; // String | Globally unique identifier for the target object.
let opts = { 
    'user': "me", 
    'opt_fields': "approval_status,message,requester,requester.name,target"
};
accessRequestsApiInstance.getAccessRequests(target, opts).then((result) => {
    console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2));
}, (error) => {
    console.error(error.response.body);
});

Parameters

Name Type Description Notes
target String Globally unique identifier for the target object.
user String A string identifying a user. This can either be the string &quot;me&quot;, an email, or the gid of a user. [optional]
opt_fields Object This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include. [optional]

Return type

object

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=UTF-8

rejectAccessRequest

Reject an access request

Rejects an access request for a target object.

(more information)

Example

const Asana = require('asana');

let client = new Asana.ApiClient();
client.authentications.token.accessToken = '<YOUR_ACCESS_TOKEN>';

let accessRequestsApiInstance = new Asana.AccessRequestsApi(client);
let access_request_gid = "12345"; // String | Globally unique identifier for the access request.

accessRequestsApiInstance.rejectAccessRequest(access_request_gid).then((result) => {
    console.log('API called successfully. Returned data: ' + JSON.stringify(result.data, null, 2));
}, (error) => {
    console.error(error.response.body);
});

Parameters

Name Type Description Notes
access_request_gid String Globally unique identifier for the access request.

Return type

object

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json; charset=UTF-8