Octopus Authenticator Management Console REST API Documentation

Agents

Agents I Agent List

Read agent list

GET https://<url>/admin/api/agents

Header

Authorization: Bearer token

Query

  • pageNum (optional, Number): Page number to read. Default: 0
  • pageSize (optional, Number): Number of records per page. Default: 25
  • orderBy (optional, String): Order method. Default: name:asc
  • search (optional, String): Text to search
  • type (optional, String): Agent type. Allowed values: "AD", "SQL". Default: AD

Agents I Create Agent

Create a new agent

POST https://<url>/admin/api/agents

Header

Authorization: Bearer token

Body

name (String): Agent's name (unique)

type (String): Agent's type. Allowed values: "AD", "SQL"

Agents I Read Agent

Read a agent

GET https://<url>/admin/api/agents/:id

Header

Authorization: Bearer token

Parameter

id (String): Agent's id

Agents I Update Agent

Update a agent

PUT https://<url>/admin/api/agents/:id

Header

Authorization: Bearer token

Parameter

id (String): Agent's id

Body

name (optional, String): Agent's name (unique)

enabled (optional, Boolean): Agent's status

Agents I Delete Agent

Delete a agent

DELETE https://<url>/admin/api/agents/:id

Header

Authorization: Bearer token

Parameter

id (String): Agent's id

Agents I Read Replicas

Read agent related replica list

GET https://<url>/admin/api/agents/:id/replicas

Header

Authorization: Bearer token

Parameter

id (String): Agent's id

Agents I Update Replicas

Assign/Unassign replicas to agent

PUT https://<url>/admin/api/agents/:id/replicas

Header

Authorization: Bearer token

Parameter

id (String): Agent's id

Body

add (String[]): Replica ids to assign

remove (String[]): Replica ids to unassign

Agents I Download Agent

Download agent installation & get installation code

POST https://<url>/admin/api/agents/:id/installations

Header

Authorization: Bearer token

Parameter

id (String): Agent's id

Apps

Apps I App List

Read app list

GET https://<url>/admin/api/apps

Header

Authorization: Bearer token

Apps I Create App

Create a new app

POST https://<url>/admin/api/apps

Header

Authorization: Bearer token

Body

name (String): App's name (unique)

type (String): App's type. Allowed values: "AD, SQL, VAULT"

Apps I Read Apps Settings

Read apps global settings

GET https://<url>/admin/api/apps/settings

Header

Authorization: Bearer token

Apps I Update Apps Settings

Update apps global settings

PUT https://<url>/admin/api/apps/settings

Header

Authorization: Bearer token

Body

appSsoTimeout (Number): SSO timeout

Apps I Remove App

Delete an app

DELETE https://<url>/admin/api/apps/:id

Header

Authorization: Bearer token

Parameter

id (Number): Apps's id

Policies

Policies I Policy List

Read policy list

GET https://<url>:/api/policies

Header

Authorization: Bearer token

Query

  • pageNum (optional, Number): Page number to read. Default: 0
  • pageSize (optional, Number): Number of records per page. Default: 25
  • orderBy (optional, String): Order method. Default: name:asc
  • search (optional, String): Text to search

Policies I Create Policy

Create a new policy

POST https://<url>:/api/policies

Header

Authorization: Bearer token

Body

name (String): Policy's name (unique)

Policies I Read Policy

Read a policy

GET https://<url>:/api/policies/:id

Header

Authorization: Bearer token

Parameter

id (String): Policy's id

Policies I Update Policy

Update a policy

PUT https://<url>:/api/policies/:id

Header

Authorization: Bearer token

Parameter

id (String): Policy's id

Body

name (optional, String): Policy's name (unique)

enabled (optional, Boolean): Policy's status

Policies I Delete Policy

Delete a policy

DELETE https://<url>:/api/policies/:id

Header

Authorization: Bearer token

Parameter

id (String): Policy's id

Replicas

Replicas I Replica List

Read replica list

GET https://<url>:/api/replicas

Header

Authorization: Bearer token

Query

  • pageNum (optional, Number): Page number to read. Default: 0
  • pageSize (optional, Number): Number of records per page. Default: 25
  • orderBy (optional, String): Order method. Default: id:asc
  • search (optional, String): Text to search
  • type (optional, String): Agent type. Allowed values: "AD", "SQL"

Users

Users I User List

Read user list

GET https://<url>:/api/users

Header

Authorization: Bearer token

Query

  • pageNum (optional, Number): Page number to read. Default: 0
  • pageSize (optional, Number): Number of records per page. Default: 25
  • orderBy (optional, String): Order method. Default: username:asc
  • search (optional, String): Text to search

Workstations

Workstations I Workstation List

Read workstation list

GET https://<url>:/api/workstations

Header

Authorization: Bearer token

Query

  • pageNum (optional, Number): Page number to read. Default: 0
  • pageSize (optional, Number): Number of records per page. Default: 25
  • orderBy (optional, String): Order method. Default: id:asc
  • search (optional, String): Text to search

Workstations I Unblock Workstation

Unblock workstation for a user

PUT https://<url>:/api/workstations/:id/users/:userId

Header

Authorization: Bearer token

Parameter

id (String): Workstation's id

userId (Number): User's id

Workstations I FileVault Password Reset

Force FileVault password change

PUT https://<url>:/api/workstations/:id/users/:userId

Header

Authorization: Bearer token

Parameter

id (String): Workstation's id

userId (Number): User's id

?️ Print

Articles in this folder -

You may like to read -

Footer - Secret Double Octopus