getUserInvitation
import { getUserInvitation } from '@esri/arcgis-rest-portal';
// username is inferred from UserSession
getUserInvitation({
invitationId: "3ef",
authentication
})
.then(response) // => response.accepted => true
Get an invitation for a user by id. See the REST Documentation for more information.
Parameters
Parameter | Type | Default | Notes |
---|---|---|---|
requestOptions Required | IGetUserInvitationOptions | options to pass through in the request |
Available requestOptions
Property | Type | Notes |
---|---|---|
string | ||
Inherited | UserSession | A session representing a logged in user. |
Optional Inherited | RequestCredentials | A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows. |
Optional Inherited | function(input: RequestInfo, init: RequestInit) : Promise<Response> | The implementation of |
Optional Inherited | [key: string]: any | Additional Headers to pass into the request. |
Optional Inherited | boolean | Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS. |
Optional Inherited | HTTPMethods | The HTTP method to send the request with. |
Optional Inherited | number | If the length of a GET request's URL exceeds |
Optional Inherited | IParams | Additional parameters to pass in the request. |
Optional Inherited | string | Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'. |
Optional Inherited | boolean | Return the raw response |
Returns
A Promise that will resolve with the invitation
Property | Type | Notes |
---|---|---|
boolean | ||
number | ||
number | ||
string | ||
number | ||
{
| ||
string | ||
boolean | ||
number | ||
string | ||
string | ||
string | ||
string | ||
string | ||
Optional | IGroup | |
Optional | string |
Function defined in packages/arcgis-rest-portal/src/users/invitation.ts:82