Create a new share for an automation project

post/projects/{projectId}/shares

Create a new share to grant access to an automation project for a specified user or group.

Note: Share creation is processed asynchronously. The response returns a 202 Accepted status with the share details (shareType, sharedWith, sharedWithType) and a link to poll for the fully synchronized share with its ID. Clients should use the "getShares" link to retrieve the complete share information after creation.

Request Samples

1

Response Samples

1{
2  "shareType": "readShare",
3  "sharedWith": "username2",
4  "sharedWithType": "user",
5  "links": [
6    {
7      "method": "GET",
8      "rel": "getShares",
9      "href": "/mlPipelineAutomation/projects/project-123/shares",
10      "uri": "/mlPipelineAutomation/projects/project-123/shares",
11      "type": "application/vnd.sas.collection",
12      "itemType": "application/vnd.sas.analytics.ml.pipeline.automation.project.share"
13    }
14  ]
15}

Path Parameters

NameTypeRequiredDescription
projectId
string
true

The automation project ID

Request Body

Project share information

This object contains information about a project share, including who the project is shared with and what level of access they have.

NameTypeRequiredDescription
id
string
false

The unique identifier for this share

projectId
string
false

The ID of the automation project being shared

shareType
string
true

The type of access granted by the share

Allowed values:
readSharereadEditShare
sharedWith
string
true

The user or group identifier that the project is shared with

sharedWithType
string
true

The type of entity the project is shared with.

  • user: Share with an individual user
  • group: Share with a group of users

Values must be exactly user, USER, group, or GROUP (case-sensitive, lowercase or UPPERCASE only).

Allowed values:
usergroup
createdBy
string
false

The user who created this share

creationTimeStamp
string<date-time>
false

The timestamp when this share was created

modifiedTimeStamp
string<date-time>
false

The timestamp when this share was last modified

links
array [Link]
false

The links that apply to this project share

Responses

StatusMeaningDescription
202Accepted

The project share creation has been accepted and is being processed asynchronously. The response contains the share request details and a link to poll for the synchronized share.

Schema
400Bad Request

The request was invalid.

Schema
403Forbidden

User does not have permission to share this project.

Schema
404Not Found

No project with the provided ID was found.

Schema