---
updatedAt: 2025-08-15T15:45:24.000Z
agentTools:
  projectIndex: https://docs.arcadia.com/v1.0-Utility-Cloud/llms.txt
---

# Update Credentials with Urjanet Connect

This endpoint generates a Connect URL that allows a user to update their password for a specified credential. The URL generated will only work for 72 hours after it is generated.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Utility Cloud",
    "description": "Utility Cloud",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://api.urjanet.com/"
    }
  ],
  "paths": {
    "/utility/credentials/{credentialId}/updateUrl": {
      "get": {
        "tags": [
          "Credentials"
        ],
        "description": "This endpoint generates a Connect URL that allows a user to update their password for a specified credential. The URL generated will only work for 72 hours after it is generated.",
        "operationId": "Update Credentials with Urjanet Connect",
        "summary": "Update Credentials with Urjanet Connect",
        "parameters": [
          {
            "name": "credentialId",
            "in": "path",
            "description": "Credential ID (UUID)",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UtilityCredentialUpdateUrlResource"
                }
              },
              "application/hal+json": {
                "schema": {
                  "$ref": "#/components/schemas/UtilityCredentialUpdateUrlResource"
                }
              }
            }
          }
        },
        "security": [
          {
            "BearerAuth": []
          },
          {
            "UnifiedAuth": []
          },
          {
            "APIKey": []
          }
        ]
      }
    }
  },
  "security": [
    {
      "BearerAuth": []
    }
  ],
  "x-amazon-apigateway-api-key-source": "AUTHORIZER",
  "x-amazon-apigateway-binary-media-types": [
    "application/pdf",
    "application/zip",
    "application/octet-stream"
  ],
  "components": {
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "UnifiedAuth": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "x-amazon-apigateway-authtype": "custom",
        "x-amazon-apigateway-authorizer": {
          "authorizerUri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:291789168161:function:${stageVariables.authenticatorFunctionName}/invocations",
          "authorizerCredentials": "arn:aws:iam::291789168161:role/${stageVariables.authenticatorRoleName}",
          "authorizerResultTtlInSeconds": 300,
          "type": "token"
        }
      },
      "APIKey": {
        "type": "apiKey",
        "name": "x-api-key",
        "in": "header"
      }
    },
    "schemas": {
      "UtilityCredentialUpdateUrlResource": {
        "properties": {
          "expiration": {
            "type": "string",
            "format": "date-time"
          },
          "updateUrl": {
            "type": "string"
          }
        },
        "title": "UtilityCredentialUpdateUrlResource",
        "type": "object"
      }
    }
  },
  "tags": [
    {
      "name": "Credentials",
      "description": "Urjanet provides credential status in Console and through the API’s credential level endpoints. When the credential job is complete, the credential’s status and status detail display the credential's current state. For example, if a credential status is OK - NO_ACTION_REQUIRED, the credential’s login was successful and statements were extracted. \n\nSee below for a complete list of credential statuses.\n\n|Completion Status|Completion Status Detail|Description|\n|---|---|---|\n|OK|NO_ACTION_REQUIRED|No action required|\n|PENDING|WEBSITE_DOWN|Temporary problem in accessing the website|\n|PENDING|UNDER_REVIEW|Urjanet is reviewing the issue and will update the status shortly|\n|PENDING|STATEMENT_UNAVAILABLE|Temporary problem in accessing bills within this credential|\n|PENDING|NAVIGATION_FAILURE|No action required|\n|ACTION_REQUIRED|LOGIN_FAILURE|Login attempt failed. Update your credentials, and the system will try again|\n|ACTION_REQUIRED|NO_ACCOUNTS_FOUND|No accounts found within this credential|\n|ACTION_REQUIRED|UNSUPPORTED_CAPTCHA|Login failed due to a captcha required by the utility. In some cases, captcha can be disabled in the utility's website settings.|\n|ACTION_REQUIRED|MULTI_FACTOR_AUTH_FAILURE|Login failed due to PIN or Access Code required by the utility for login.|\n|ACTION_REQUIRED|USER_ACTION_REQUIRED|Login attempt passed, but unable to reach to the account information|\n|ACTION_REQUIRED|SECURITY_QUESTIONS|Login attempt failed due to security questions posed by the utility. Add security questions & answers using the additional login fields.|\n|ACTION_REQUIRED|ACCOUNT_LOCKED|Login failed due to account lockout. Please unlock the account.|\n|ACTION_REQUIRED|E_BILL_REQUIRED|Enrollment in electronic billing is required to access online statements.|\n"
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-enabled": true
  }
}
```