Skip to content
API Reference
Sharing

Documents sharing

Documents sharing in Prism / Objects / Documents — Micro Go reference.

Reference for Go SDK 0.8.0.

Release source · Setup and client configuration

Update

PUT /v2/prism/{teamId}/document/{documentId}/grant

client.Prism.Objects.Documents.Grant.Update(ctx context.Context, documentID string, params micro.PrismObjectDocumentGrantUpdateParams) (*micro.PrismObjectDocumentGrantUpdateResponse, error)

Update grant

Get

GET /v2/prism/{teamId}/document/{documentId}/grant

client.Prism.Objects.Documents.Grant.Get(ctx context.Context, documentID string, query micro.PrismObjectDocumentGrantGetParams) (*micro.PrismObjectDocumentGrantGetResponse, error)

Get grant

Parameter and response types

These declarations show the request parameters and response shapes used by the methods above.

PrismObjectDocumentGrantUpdateResponse

Source

type PrismObjectDocumentGrantUpdateResponse struct {
	TeamGroupID []map[string]PrismObjectDocumentGrantUpdateResponseTeamGroupID `json:"team_group_id"`
	TeamID      map[string]PrismObjectDocumentGrantUpdateResponseTeamID        `json:"team_id"`
	UserID      []map[string]PrismObjectDocumentGrantUpdateResponseUserID      `json:"user_id"`
	JSON        prismObjectDocumentGrantUpdateResponseJSON                     `json:"-"`
}

PrismObjectDocumentGrantGetResponse

Source

type PrismObjectDocumentGrantGetResponse struct {
	TeamGroupID []map[string]PrismObjectDocumentGrantGetResponseTeamGroupID `json:"team_group_id"`
	TeamID      map[string]PrismObjectDocumentGrantGetResponseTeamID        `json:"team_id"`
	UserID      []map[string]PrismObjectDocumentGrantGetResponseUserID      `json:"user_id"`
	JSON        prismObjectDocumentGrantGetResponseJSON                     `json:"-"`
}

PrismObjectDocumentGrantUpdateParams

Source

type PrismObjectDocumentGrantUpdateParams struct {
	// Use [option.WithTeamID] on the client to set a global default for this field.
	PathTeamID     param.Field[string]                                                       `path:"teamId" api:"required" format:"uuid"`
	TeamGroupID    param.Field[[]map[string]PrismObjectDocumentGrantUpdateParamsTeamGroupID] `json:"team_group_id"`
	BodyTeamID     param.Field[map[string]PrismObjectDocumentGrantUpdateParamsTeamID]        `json:"team_id"`
	UserID         param.Field[[]map[string]PrismObjectDocumentGrantUpdateParamsUserID]      `json:"user_id"`
	IdempotencyKey param.Field[string]                                                       `header:"Idempotency-Key"`
}

PrismObjectDocumentGrantGetParams

Source

type PrismObjectDocumentGrantGetParams struct {
	// Use [option.WithTeamID] on the client to set a global default for this field.
	TeamID param.Field[string] `path:"teamId" api:"required" format:"uuid"`
}

PrismObjectDocumentGrantUpdateResponseTeamGroupID

Source

type PrismObjectDocumentGrantUpdateResponseTeamGroupID string

PrismObjectDocumentGrantUpdateResponseTeamID

Source

type PrismObjectDocumentGrantUpdateResponseTeamID string

PrismObjectDocumentGrantUpdateResponseUserID

Source

type PrismObjectDocumentGrantUpdateResponseUserID string

PrismObjectDocumentGrantGetResponseTeamGroupID

Source

type PrismObjectDocumentGrantGetResponseTeamGroupID string

PrismObjectDocumentGrantGetResponseTeamID

Source

type PrismObjectDocumentGrantGetResponseTeamID string

PrismObjectDocumentGrantGetResponseUserID

Source

type PrismObjectDocumentGrantGetResponseUserID string

PrismObjectDocumentGrantUpdateParamsTeamGroupID

Source

type PrismObjectDocumentGrantUpdateParamsTeamGroupID string

PrismObjectDocumentGrantUpdateParamsTeamID

Source

type PrismObjectDocumentGrantUpdateParamsTeamID string

PrismObjectDocumentGrantUpdateParamsUserID

Source

type PrismObjectDocumentGrantUpdateParamsUserID string
micro.so