Azure Automation Credential API
The Credential API from Azure Automation — 2 operation(s) for credential.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/microsoft-azure-automation:microsoft-azure-automation-credential-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Microsoft Azure Automation Credential API
version: '2024-10-23'
x-typespec-generated:
- emitter: '@azure-tools/typespec-autorest'
description: 'Operations tagged Credential across 2 of this provider''s published API definitions: microsoft-azure-automation-openapi.json, microsoft-azure-automation-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
- user_impersonation
tags:
- name: Credential
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials
: get:
operationId: Credential_ListByAutomationAccount
tags:
- Credential
description: Retrieve a list of credentials.
externalDocs:
url: http://aka.ms/azureautomationsdk/credentialoperations
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: automationAccountName
in: path
description: The name of the automation account.
required: true
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialListResult'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
List credentials by automation account, first 100:
$ref: ./examples/listCredentialsByAutomationAccount.json
List credentials by automation account, next 100:
$ref: ./examples/listCredentialsByAutomationAccount_next100_using_nextLink.json
x-ms-pageable:
nextLinkName: nextLink
summary: Credential list by automation account
x-summary-source: derived
servers:
- url: https://management.azure.com
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/credentials/{credentialName}
: get:
operationId: Credential_Get
tags:
- Credential
description: Retrieve the credential identified by credential name.
externalDocs:
url: http://aka.ms/azureautomationsdk/credentialoperations
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: automationAccountName
in: path
description: The name of the automation account.
required: true
schema:
type: string
- name: credentialName
in: path
description: The name of credential.
required: true
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Credential'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Get a credential:
$ref: ./examples/getCredential.json
summary: Credential get
x-summary-source: derived
put:
operationId: Credential_CreateOrUpdate
tags:
- Credential
description: Create a credential.
externalDocs:
url: http://aka.ms/azureautomationsdk/credentialoperations
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: automationAccountName
in: path
description: The name of the automation account.
required: true
schema:
type: string
- name: credentialName
in: path
description: The name of credential.
required: true
schema:
type: string
responses:
'200':
description: Resource 'Credential' update operation succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/Credential'
'201':
description: Resource 'Credential' create operation succeeded
content:
application/json:
schema:
$ref: '#/components/schemas/Credential'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Create a credential:
$ref: ./examples/createOrUpdateCredential.json
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialCreateOrUpdateParameters'
description: The parameters supplied to the create or update credential operation.
required: true
summary: Credential create or update
x-summary-source: derived
patch:
operationId: Credential_Update
tags:
- Credential
description: Update a credential.
externalDocs:
url: http://aka.ms/azureautomationsdk/credentialoperations
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: automationAccountName
in: path
description: The name of the automation account.
required: true
schema:
type: string
- name: credentialName
in: path
description: The name of credential.
required: true
schema:
type: string
responses:
'200':
description: Azure operation completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Credential'
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Update a credential:
$ref: ./examples/updateCredential_patch.json
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CredentialUpdateParameters'
description: The parameters supplied to the Update credential operation.
required: true
summary: Credential update
x-summary-source: derived
delete:
operationId: Credential_Delete
tags:
- Credential
description: Delete the credential.
externalDocs:
url: http://aka.ms/azureautomationsdk/credentialoperations
parameters:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
- name: automationAccountName
in: path
description: The name of the automation account.
required: true
schema:
type: string
- name: credentialName
in: path
description: The name of credential.
required: true
schema:
type: string
responses:
'200':
description: Resource deleted successfully.
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
x-ms-examples:
Delete a credential:
$ref: ./examples/deleteCredentialExisting.json
summary: Credential delete
x-summary-source: derived
servers:
- url: https://management.azure.com
components:
schemas:
CredentialCreateOrUpdateParameters:
type: object
description: The parameters supplied to the create or update credential operation.
properties:
name:
type: string
description: Gets or sets the name of the credential.
properties:
$ref: '#/components/schemas/CredentialCreateOrUpdateProperties'
description: Gets or sets the properties of the credential.
x-ms-client-flatten: true
required:
- name
- properties
CredentialProperties:
type: object
description: Definition of the credential properties
properties:
userName:
type: string
description: Gets the user name of the credential.
readOnly: true
creationTime:
type: string
format: date-time
description: Gets the creation time.
readOnly: true
lastModifiedTime:
type: string
format: date-time
description: Gets the last modified time.
readOnly: true
description:
type: string
description: Gets or sets the description.
CredentialUpdateProperties:
type: object
description: The properties of the Update credential
properties:
userName:
type: string
description: Gets or sets the user name of the credential.
password:
type: string
description: Gets or sets the password of the credential.
description:
type: string
description: Gets or sets the description of the credential.
CredentialUpdateParameters:
type: object
description: The parameters supplied to the Update credential operation.
properties:
name:
type: string
description: Gets or sets the name of the credential.
properties:
$ref: '#/components/schemas/CredentialUpdateProperties'
description: Gets or sets the properties of the variable.
x-ms-client-flatten: true
Credential:
type: object
description: Definition of the credential.
properties:
properties:
$ref: '#/components/schemas/CredentialProperties'
description: Gets or sets the properties of the credential.
x-ms-client-flatten: true
allOf:
- $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
CredentialCreateOrUpdateProperties:
type: object
description: The properties of the create credential operation.
properties:
userName:
type: string
description: Gets or sets the user name of the credential.
password:
type: string
description: Gets or sets the password of the credential.
description:
type: string
description: Gets or sets the description of the credential.
required:
- userName
- password
CredentialListResult:
type: object
description: The response of a Credential list operation.
properties:
value:
type: array
description: The Credential items on this page
items:
$ref: '#/components/schemas/Credential'
nextLink:
type: string
format: uri
description: The link to the next page of items
required:
- value
securitySchemes:
azure_auth:
type: oauth2
flows:
implicit:
scopes:
user_impersonation: impersonate your user account
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
description: Azure Active Directory OAuth2 Flow.
x-refined-from:
- microsoft-azure-automation-openapi.json
- microsoft-azure-automation-management-openapi.yml