Automation Identities

APIs for automation identities.

List Automation Identities from a Tenant

Returns automation identity objects.

Request

GET /api/v1/Tenants/{tenantId}/AutomationIdentities
?tag={tag}&query={query}&skip={skip}&count={count}

Parameters

string tenantId
Tenant identifier

[optional] array tag
Only return automation identities that have at least one of these tags

[optional] string query
(not supported) Search string identifier

[optional] integer skip
Number of automation identities to skip. Ignored if a list of Ids is passed.

[optional] integer count
Maximum number of automation identities to return. Ignored if a list of Ids is passed.

Response

Example response body

200 Response (AutomationIdentity[])

[
  {
    "Id": "string",
    "Name": "string",
    "TenantId": "string",
    "RoleIds": [
      "string"
    ],
    "RoleTypeIds": [
      "string"
    ],
    "Tags": [
      "string"
    ]
  }
]

Authorization

Allowed for these roles:

• Tenant Member

Get Total Count of Automation Identities from Tenant

Returns the total number of automation identities in tenant in the Total-Count header.

Request

HEAD /api/v1/Tenants/{tenantId}/AutomationIdentities
?tag={tag}

Parameters

string tenantId
Tenant identifier

[optional] array tag
Only count automation identities that have at least one of these tags.

Response

Authorization

Allowed for these roles:

• Tenant Member

Create an Automation Identity

Creates an automation identity. A non-administrator caller must have all roles being assigned to the new automation identity.

Request

POST /api/v1/Tenants/{tenantId}/AutomationIdentities

Parameters

string tenantId
Tenant identifier

Request Body

New automation identity object

{
  "Name": "string",
  "RoleIds": [
    "string"
  ],
  "Tags": [
    "string"
  ]
}

Response

Example response body

201 Response (AutomationIdentity)

{
  "Id": "string",
  "Name": "string",
  "TenantId": "string",
  "RoleIds": [
    "string"
  ],
  "RoleTypeIds": [
    "string"
  ],
  "Tags": [
    "string"
  ]
}

Authorization

Allowed for these roles:

• Tenant Member

Get an Automation Identity

Returns automation identity object.

Request

GET /api/v1/Tenants/{tenantId}/AutomationIdentities/{automationIdentityId}

Parameters

string tenantId
Tenant identifier

string automationIdentityId
Automation identity unique identifier

Response

Example response body

200 Response (AutomationIdentity)

{
  "Id": "string",
  "Name": "string",
  "TenantId": "string",
  "RoleIds": [
    "string"
  ],
  "RoleTypeIds": [
    "string"
  ],
  "Tags": [
    "string"
  ]
}

Authorization

Allowed for these roles:

• Tenant Member

Get Header for Automation Identity

Validates that an automation identity exists in tenant.

Request

HEAD /api/v1/Tenants/{tenantId}/AutomationIdentities/{automationIdentityId}

Parameters

string tenantId
Tenant identifier

string automationIdentityId
Automation identity unique identifier

Response

Authorization

Allowed for these roles:

• Tenant Member

Update Automation Identity

Updates an automation identity. A non-administrator caller must have all roles belonging to the existing automation identity, as well as any roles being added.

Request

PUT /api/v1/Tenants/{tenantId}/AutomationIdentities/{automationIdentityId}

Parameters

string tenantId
Tenant identifier

string automationIdentityId
Automation identity unique identifier

Request Body

Automation identity object. Properties that are not set or are null will not be changed.

{
  "Name": "string",
  "RoleIds": [
    "string"
  ],
  "Tags": [
    "string"
  ]
}

Response

Example response body

200 Response (AutomationIdentity)

{
  "Id": "string",
  "Name": "string",
  "TenantId": "string",
  "RoleIds": [
    "string"
  ],
  "RoleTypeIds": [
    "string"
  ],
  "Tags": [
    "string"
  ]
}

Authorization

Allowed for these roles:

• Tenant Member

Delete an Automation Identity

Deletes an automation identity. A non-administrator caller must have all roles belonging to the automation identity being deleted.

Request

DELETE /api/v1/Tenants/{tenantId}/AutomationIdentities/{automationIdentityId}

Parameters

string tenantId
Tenant identifier

string automationIdentityId
Automation identity unique identifier

Response

Authorization

Allowed for these roles:

• Tenant Member

Definitions

AutomationIdentity

Automation identity.

Properties

{
  "Id": "string",
  "Name": "string",
  "TenantId": "string",
  "RoleIds": [
    "string"
  ],
  "RoleTypeIds": [
    "string"
  ],
  "Tags": [
    "string"
  ]
}

ErrorResponse

Object returned whenever there is an error

Properties

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "DynamicProperties": {
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}

AutomationIdentityCreate

The model for creating an Automation Identity.

Properties

{
  "Name": "string",
  "RoleIds": [
    "string"
  ],
  "Tags": [
    "string"
  ]
}

AutomationIdentityUpdate

The model for updating an automation identity.

Properties

{
  "Name": "string",
  "RoleIds": [
    "string"
  ],
  "Tags": [
    "string"
  ]
}