Skip to main content

Update Admin API application

PUT 
/api/web/v1/applications/adminapi/:id

Update an Admin API application. Caller requires the APPLICATIONS:EDIT permission.

Request​

Path Parameters

    id stringrequired

    The UUID of the application to be updated.

Body

required

    allowLongLivedToken boolean

    Determines if a long-lived token is allowed in this application.

    applicationTemplateId string

    The UUID of the application template. This value is only used when creating a new application. If not specified, the default admininstration API template is used.

    description string

    Short description of application.

    ipListId string

    The UUID of the IP Addresses list.

    logo string

    Base64 encoded logo image.

    name stringrequired

    Name of application.

    roleId string

    The UUID of the Site role to be associated with the API application. Pass an empty string value to unset the site role. Either this value or spRoleId is required when creating the application.

    spRoleId string

    The UUID of the service provider role to be associated with the API application. Pass an empty string to unset the service provider role. Either this value or roleId is required when creating the application.

Responses​

Successful

Schema

    allowLongLivedToken boolean

    Determines if the application can use a long-lived token for authentication.

    applicationTemplate stringrequired

    The name of the application template specific to this application type.

    applicationTemplateId string

    Application template id specific to this application type.

    description string

    Short description of application.

    id string

    Application ID.

    ipListId string

    The UUID of the IP Addresses list.

    lastAuthnDate date-time

    Last successful authentication time to use administration api

    logo string

    Base64 encoded logo image.

    name stringrequired

    Name of application.

    roleId string

    The UUID of the Site role to be associated with the API application. Pass an empty string value to unset the site role.

    sharedSecret string

    Shared secret for application.

    spRoleId string

    The UUID of the service provider role to be associated with the API application. Pass an empty string to unset the service provider role.

Loading...