Experimental

The Unix Cluster Account API is implemented via the Unix Cluster Plugin. REST APIs provided by plugins are currently considered Experimental, and as such this interface may change without notice between minor releases.


Implementation Notes

  • Only JSON format is supported. XML format is not supported.
  • The URLs for this API use plugin syntax. (There is an extra component to the path.)

Add

Add a new Unix Cluster Account.

Request Format

Method

POST

URL

/unix_cluster/unix_cluster_accounts.<format>

Request Body

UnixClusterAccount Request

Response Format

HTTP Status

Response Body

Description

201 Added

NewObjectResponse with ObjectType of UnixClusterAccount

Unix Cluster Account added

400 Bad Request


Unix Cluster Account Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized


Authentication required

500 Other Error


Unknown error

Delete

Remove a Unix Cluster Account.

Request Format

Method

DELETE

URL

/unix_cluster/unix_cluster_accounts/<id>.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 Deleted


Unix Cluster Account deleted

400 Invalid Fields


id not provided

401 Unauthorized


Authentication required

404 UnixClusterAccount Unknown


id not found

500 Other Error


Unknown error

Edit

Edit an existing Unix Cluster Account.

Request Format

Method

PUT

URL

/unix_cluster/unix_cluster_accounts/<id>.<format>

Request Body

UnixClusterAccount Request

Response Format

HTTP Status

Response Body

Description

200 OK


Unix Cluster Account updated

400 Bad Request


Unix Cluster Account Request not provided in POST body

400 Invalid Fields

ErrorResponse with details in InvalidFields element

An error in one or more provided fields

401 Unauthorized


Authentication required

404 Unix Cluster Account Unknown


id not found

500 Other Error


Unknown error

View (all)

Retrieve all existing Unix Cluster Accounts.

Request Format

Method

GET

URL

/unix_cluster/unix_cluster_accounts.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

UnixClusterAccount Response

Unix Cluster Account returned

401 Unauthorized


Authentication required

500 Other Error


Unknown error

View (per CO Person)

Retrieve Unix Cluster Accounts attached to a CO Person.

Request Format

Method

GET

URL

/unix_cluster/unix_cluster_accounts.<format>?copersonid=<id>

Request Body


Response Format

200 OK

UnixClusterAccount Response

Unix Cluster Accounts returned

401 Unauthorized


Authentication required

404 CoPerson Unknown


id not found

500 Other Error


Unknown error

View (per Unix Cluster)

Retrieve Unix Cluster Accounts attached to a Unix Cluster.

Request Format

Method

GET

URL

/unix_cluster/unix_cluster_accounts.<format>?unix_cluster_id=<id>

Request Body


Response Format

200 OK

UnixClusterAccount Response

Unix Cluster Accounts returned

401 Unauthorized


Authentication required

404 Unix Cluster Unknown


id not found

500 Other Error


Unknown error

View (one)

Retrieve an existing Unix Cluster Account.

Request Format

Method

GET

URL

/unix_cluster/unix_cluster_accounts/<id>.<format>

Request Body


Response Format

HTTP Status

Response Body

Description

200 OK

UnixClusterAccount Response

Unix Cluster Account returned

401 Unauthorized


Authentication required

404 UnixClusterAccount Unknown


id not found

500 Other Error


Unknown error

Notes

  • Response format requested is ignored where response is only via HTTP status, but must still be provided.

See Also

  • No labels