Conduit owners.edit

owners.edit

API Method: owners.edit

Summary

Apply transactions to create a new Owners package or edit an existing one.

Returns

map<string, wild>

Errors

ERR-CONDUIT-CORE: See error message for details.

OAuth Scope

OAuth clients may never call this method.

Method Description

This is a standard ApplicationEditor method which allows you to create and modify objects by applying transactions. For documentation on these endpoints, see Conduit API: Using Edit Endpoints.

Transaction Summary

This endpoint supports these types of transactions. See below for detailed information about each transaction type.

Key	Description
name	Name of the package.
owners	Users and projects which own the package.
dominion	Change package dominion rules.
authority	Change package authority rules.
autoReview	Automatically trigger reviews for commits affecting files in this package.
auditing	Automatically trigger audits for commits affecting files in this package.
description	Human-readable description of the package.
status	Archive or enable the package.
ignored	Ignore paths with any of these attributes.
paths.set	Overwrite existing package paths with new paths.
view	Change the view policy of the object.
edit	Change the edit policy of the object.
mfa	Sign this transaction group with MFA.

name

Name of the package.

Key	Type	Description
type	const	name
value	string

owners

Users and projects which own the package.

Key	Type	Description
type	const	owners
value	list<phid>

dominion

Change package dominion rules.

Key	Type	Description
type	const	dominion
value	string

authority

Change package authority rules.

Key	Type	Description
type	const	authority
value	string

autoReview

Automatically trigger reviews for commits affecting files in this package.

Key	Type	Description
type	const	autoReview
value	string

auditing

Automatically trigger audits for commits affecting files in this package.

Key	Type	Description
type	const	auditing
value	string

description

Human-readable description of the package.

Key	Type	Description
type	const	description
value	string

status

Archive or enable the package.

Key	Type	Description
type	const	status
value	string

ignored

Ignore paths with any of these attributes.

Key	Type	Description
type	const	ignored
value	list<string>

paths.set

Overwrite existing package paths with new paths.

When updating the paths for a package, pass a list of dictionaries like this as the value for the transaction:

Example Paths Value

[
  {
    "repositoryPHID": "PHID-REPO-1234",
    "path": "/path/to/directory/",
    "excluded": false
  },
  {
    "repositoryPHID": "PHID-REPO-1234",
    "path": "/another/example/path/",
    "excluded": false
  }
]

This transaction will set the paths to the list you provide, overwriting any previous paths.

Generally, you will call owners.search first to get a list of current paths (which are provided in the same format), make changes, then update them by applying a transaction of this type.

Key	Type	Description
type	const	paths.set
value	wild	List of dictionaries, each describing a path.

view

Change the view policy of the object.

Key	Type	Description
type	const	view
value	string	New policy PHID or constant.

edit

Change the edit policy of the object.

Key	Type	Description
type	const	edit
value	string	New policy PHID or constant.

mfa

Sign this transaction group with MFA.

Key	Type	Description
type	const	mfa
value	bool

Call Method

Examples

Use the Conduit API Tokens panel in Settings to generate or manage API tokens.
If you submit parameters, these examples will update to show exactly how to encode the parameters you submit.

$ echo <json-parameters> | arc call-conduit --conduit-uri https://nazrin.limited/ --conduit-token <conduit-token> -- owners.edit