Update an application

Update an existing application. The only fields that can be updated by the user are: name, description, oauthRedirectURI and public. If other read-only fields of the application are passed during the update operation, they are simply ignored by the server.

Sample method invocation

  curl -X PUT \
    -u userid:pw \
    -H 'Content-Type: application/json' \
    -d '        
        {
           "name": string,
           "appImageURL": string,
           "description": string,
           "oauthRedirectURI": string,
           "public": boolean
        }
        
       ' \
    https://<mgmt-cluster-ip>/v1/portal/orgs/{orgID}/apps/{appID}

Parameters

Path Parameters

orgID : Organization ID

appID : Application ID

Response content

MIME type: application/json

 
 {
    id: string
    name: string
    url: string
    appCredentials: array[
       {
          id: string
          url: string
          clientID: string
          clientSecret: string
          description: string
       }
    ]
    appImageURL: string
    credentials: 
    {
       url: string
       clientID: string
       clientSecret: string
       description: string
    }
    
    description: string
    enabled: boolean
    imageURL: string
    oauthRedirectURI: string
    orgID: string
    promoteTo: enum['PRODUCTION' or 'DEVELOPMENT']
    public: boolean
    state: enum['SUSPENDED' or 'ACTIVE']
    type: enum['PRODUCTION' or 'DEVELOPMENT']
    createdAt: string
    updatedAt: string
 }

Status codes

200 : The application was updated.

401 : Authentication failed. Valid username and password are required.

403 : Authenticated user is not a member of orgs/{orgID}

404 : Resource not found.

409 : There is already an application with the same name.

500 : An internal error has occurred.

Available since API Connect 5.0.0