Templates

Shares a template with a group

PUT
/v2.1/accounts/{accountId}/templates/{templateId}/{templatePart}

Shares a template with the specified members group.

Note: For a newer version of this functionality, see Accounts: Update Shared Access.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

The external account number (int) or account ID GUID.

templateId*string

The ID of the template.

templatePart*string

Currently, the only defined part is groups.

Request Body

application/json

This object is used for both requests and responses. Some properties (such as endPosition) only apply to the response of Groups: list.

endPosition?string

The last index position in the result set.

groups?array<>

A collection group objects containing information about the groups.

nextUri?string

The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.

previousUri?string

The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.

resultSetSize?string

The number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the totalSetSize.

startPosition?string

The starting index position of the current result set.

totalSetSize?string

The total number of items in the result set. This value is always greater than or equal to the value of resultSetSize.

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/templates/string/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "endPosition": "string",  "groups": [    {      "accessType": "string",      "dsGroupId": "string",      "errorDetails": {        "errorCode": "string",        "message": "string"      },      "groupId": "string",      "groupName": "string",      "groupType": "string",      "isManagedByScim": true,      "lastModifiedOn": "string",      "permissionProfileId": "string",      "userGroupType": "string",      "users": [        {          "accountId": "string",          "accountName": "string",          "activationAccessCode": "string",          "email": "string",          "errorDetails": {            "errorCode": "string",            "message": "string"          },          "ipAddress": "string",          "loginStatus": "string",          "membershipId": "string",          "sendActivationEmail": "string",          "uri": "string",          "userId": "string",          "userName": "string",          "userStatus": "string",          "userType": "string"        }      ],      "usersCount": "string"    }  ],  "nextUri": "string",  "previousUri": "string",  "resultSetSize": "string",  "startPosition": "string",  "totalSetSize": "string"}