Versions Compared

Old Version 1

changes.mady.by.user Technical writer

Saved on

compared with

New Version Current

changes.mady.by.user Technical writer

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Makes changes to an existing access.

HTTP

Method

method

URI Scheme

PUT

/server/access/{accessId}

Parameters

Type

Name

Description

Qualification

Schema

Path

accessId

The ID of the access to update.

Required

string

Body

request

Request body parameters, see schema for details.

Required

Access

Responses

HTTP

Code

code

Common messages

Description

Schema

200

The updated access.

Access

400

The application with the specified key could not be found

String

Input not valid: First name and last name must always be specified.

String

Input not valid: Changing state of an access from INVITED to <%1> is not allowed.

<%1> can be replaced by either ACTIVE or DEACTIVATED.

String

Invalid role ID format

This error message is returned when

  • a global ID on the path section of the URL is not in the correct format.

  • the "id" field in the Access object is missing or formatted incorrectly.

Info

It is not necessarily related to a role and its ID.

String

Input not valid: Access ID must match the access ID in the REST path.

String

Input not valid: State must be specified when updating an access.

String

500

An unexpected error occurred: Type definition error <%1>

This error messages can be returned if one or more parameters are of the wrong type. Refer to Access for details.

String

Security

Type

Name

apiKey

Key