openapi-directory/api/azure.com/authorization-authorization-RoleDefinitionsCalls.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations allow you to manage role definitions. A role definition describes the set of actions that can be performed on resources.","title":"AuthorizationManagementClient","version":"2018-01-01-preview","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/authorization/resource-manager/Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"authorization-authorization-RoleDefinitionsCalls","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Authorization/permissions":{"get":{"description":"Gets all permissions the caller has for a resource group.","operationId":"Permissions_ListForResourceGroup","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns an array of permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionGetResult"},"examples":{"GetConfigurations":{"$ref":"#/components/examples/GetConfigurations"}}}}}},"tags":["Permissions"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/permissions":{"get":{"description":"Gets all permissions the caller has for a resource.","operationId":"Permissions_ListForResource","parameters":[{"$ref":"#/components/parameters/ResourceGroupNameParameter"},{"$ref":"#/components/parameters/ResourceProviderNamespaceParameter"},{"description":"The parent resource identity.","in":"path","name":"parentResourcePath","required":true,"x-ms-skip-url-encoding":true,"schema":{"type":"string"},"examples":{"GetConfigurations":{"value":"parentResourcePath"}}},{"description":"The resource type of the resource.","in":"path","name":"resourceType","required":true,"x-ms-skip-url-encoding":true,"schema":{"type":"string"},"examples":{"GetConfigurations":{"value":"resourceType"}}},{"description":"The name of the resource to get the permissions for.","in":"path","name":"resourceName","required":true,"schema":{"type":"string"},"examples":{"GetConfigurations":{"value":"resourceName"}}},{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"}],"responses":{"200":{"description":"OK - Returns an array of permissions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PermissionGetResult"},"examples":{"GetConfigurations":{"$ref":"#/components/examples/GetConfigurations"}}}}}},"tags":["Permissions"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/{scope}/providers/Microsoft.Authorization/roleDefinitions":{"get":{"description":"Get all role definitions that are applicable at scope and above.","operationId":"RoleDefinitions_List","parameters":[{"description":"The scope of the role definition.","in":"path","name":"scope","required":true,"x-ms-skip-url-encoding":true,"schema":{"type":"string"},"examples":{"GetConfigurations":{"value":"scope"}}},{"description":"The filter to apply on the operation. Use atScopeAndBelow filter to search below the given scope as well.","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Returns an array of role definitions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleDefinitionListResult"},"examples":{"GetConfigurations":{"$ref":"#/components/examples/GetConfigurations"}}}}}},"tags":["RoleDefinitions"],"x-ms-odata":"#/components/schemas/RoleDefinitionFilter","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/{scope}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId}":{"delete":{"description":"Deletes a role definition.","operationId":"RoleDefinitions_Delete","parameters":[{"description":"The scope of the role definition.","in":"path","name":"scope","required":true,"x-ms-skip-url-encoding":true,"schema":{"type":"string"},"examples":{"GetConfigurations":{"value":"scope"}}},{"description":"The ID of the role definition to delete.","in":"path","name":"roleDefinitionId","required":true,"schema":{"type":"string"},"examples":{"GetConfigurations":{"value":"roleDefinitionId"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Returns information about the role definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleDefinition"},"examples":{"GetConfigurations":{"$ref":"#/components/examples/GetConfigurations"}}}}}},"tags":["RoleDefinitions"]},"get":{"description":"Get role definition by name (GUID).","operationId":"RoleDefinitions_Get","parameters":[{"description":"The scope of the role definition.","in":"path","name":"scope","required":true,"x-ms-skip-url-encoding":true,"schema":{"type":"string"},"examples":{"GetConfigurations":{"value":"scope"}}},{"description":"The ID of the role definition.","in":"path","name":"roleDefinitionId","required":true,"schema":{"type":"string"},"examples":{"GetConfigurations":{"value":"roleDefinitionId"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Returns information about the role definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleDefinition"},"examples":{"GetConfigurations":{"$ref":"#/components/examples/GetConfigurations"}}}}}},"tags":["RoleDefinitions"]},"put":{"description":"Creates or updates a role definition.","operationId":"RoleDefinitions_CreateOrUpdate","parameters":[{"description":"The scope of the role definition.","in":"path","name":"scope","required":true,"x-ms-skip-url-encoding":true,"schema":{"type":"string"},"examples":{"GetConfigurations":{"value":"scope"}}},{"description":"The ID of the role definition.","in":"path","name":"roleDefinitionId","required":true,"schema":{"type":"string"},"examples":{"GetConfigurations":{"value":"roleDefinitionId"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleDefinition"}}},"description":"The values for the role definition.","required":true},"responses":{"201":{"description":"OK - Returns information about the role definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleDefinition"},"examples":{"GetConfigurations":{"$ref":"#/components/examples/GetConfigurations"}}}}}},"tags":["RoleDefinitions"]}},"/{roleId}#disambiguation_dummy":{"get":{"description":"Gets a role definition by ID.","operationId":"RoleDefinitions_GetById","parameters":[{"description":"The fully qualified role definition ID. Use the format, /subscriptions/{guid}/providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for subscription level role definitions, or /providers/Microsoft.Authorization/roleDefinitions/{roleDefinitionId} for tenant level role definitions.","in":"path","name":"roleId","required":true,"x-ms-skip-url-encoding":true,"schema":{"type":"string"},"examples":{"GetConfigurations":{"value":"roleDefinitionId"}}},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - Returns information about the role definition.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoleDefinition"},"examples":{"GetConfigurations":{"$ref":"#/components/examples/GetConfigurations"}}}}}},"tags":["RoleDefinitions"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"GetConfigurations":{"value":{"id":"/subscriptions/subID/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId","name":"roleDefinitionId","properties":{"assignableScopes":["/subscriptions/subId"],"description":"Role description","permissions":[{"actions":["action"],"dataActions":["dataAction"],"notActions":[],"notDataActions":[]}],"roleName":"Role name","type":"roletype"},"type":"Microsoft.Authorization/roleDefinitions"}}},"parameters":{"ApiVersionParameter":{"description":"The API version to use for this operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"GetConfigurations":{"value":"2018-01-01-preview"}}},"FilterParameter":{"description":"The filter to apply on the operation. Use $filter=atScope() to return all deny assignments at or above the scope. Use $filter=denyAssignmentName eq '{name}' to search deny assignments by name at specified scope. Use $filter=principalId eq '{id}' to return all deny assignments at, above and below the scope for the specified principal. Use $filter=gdprExportPrincipalId eq '{id}' to return all deny assignments at, above and below the scope for the specified principal. This filter is different from the principalId filter as it returns not only those deny assignments that contain the specified principal is the Principals list but also those deny assignments that contain the specified principal is the ExcludePrincipals list. Additionally, when gdprExportPrincipalId filter is used, only the deny assignment name and description properties are returned.","in":"query","name":"$filter","required":false,"x-ms-parameter-location":"method","schema":{"type":"string"}},"ResourceGroupNameParameter":{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"GetConfigurations":{"value":"rgname"}}},"ResourceProviderNamespaceParameter":{"description":"The namespace of the resource provider.","in":"path","name":"resourceProviderNamespace","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"GetConfigurations":{"value":"rpnamespace"}}},"SubscriptionIdParameter":{"description":"The ID of the target subscription.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"GetConfigurations":{"value":"subId"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"Permission":{"description":"Role definition permissions.","properties":{"actions":{"description":"Allowed actions.","items":{"type":"string"},"type":"array"},"dataActions":{"description":"Allowed Data actions.","items":{"type":"string"},"type":"array"},"notActions":{"description":"Denied actions.","items":{"type":"string"},"type":"array"},"notDataActions":{"description":"Denied Data actions.","items":{"type":"string"},"type":"array"}}},"PermissionGetResult":{"description":"Permissions information.","properties":{"nextLink":{"description":"The URL to use for getting the next set of results.","type":"string"},"value":{"description":"An array of permissions.","items":{"$ref":"#/components/schemas/Permission"},"type":"array"}}},"RoleDefinition":{"description":"Role definition.","properties":{"id":{"description":"The role definition ID.","readOnly":true,"type":"string"},"name":{"description":"The role definition name.","readOnly":true,"type":"string"},"properties":{"$ref":"#/components/schemas/RoleDefinitionProperties"},"type":{"description":"The role definition type.","readOnly":true,"type":"string"}}},"RoleDefinitionFilter":{"description":"Role Definitions filter","properties":{"roleName":{"description":"Returns role definition with the specific name.","type":"string"},"type":{"description":"Returns role definition with the specific type.","type":"string"}}},"RoleDefinitionListResult":{"description":"Role definition list operation result.","properties":{"nextLink":{"description":"The URL to use for getting the next set of results.","type":"string"},"value":{"description":"Role definition list.","items":{"$ref":"#/components/schemas/RoleDefinition"},"type":"array"}}},"RoleDefinitionProperties":{"description":"Role definition properties.","properties":{"assignableScopes":{"description":"Role definition assignable scopes.","items":{"type":"string"},"type":"array"},"description":{"description":"The role definition description.","type":"string"},"permissions":{"description":"Role definition permissions.","items":{"$ref":"#/components/schemas/Permission"},"type":"array"},"roleName":{"description":"The role name.","type":"string"},"type":{"description":"The role type.","type":"string","x-ms-client-name":"roleType"}}}}}}