POST /config/access/authorized_services/{id}

Edit online

Updates an authorized service. Only the label, tenant_id, security_profile_id, user_role_id, and expiration_date fields can be updated.

To view any authorized service, the caller must have the Administrator Manager permission. Callers without the Administrator Manager permission can only see the authorized services that they've created. An authorized service can see itself and other authorized services it created, but the Administrator Manager permission is needed to see the complete list of authorized services.

Only the label, tenant_id, security_profile_id, user_role_id, and expiration_date fields can be set when creating an authorized service. All other fields are ignored.

Table 1. POST /config/access/authorized_services/{id} resource details
MIME Type
application/json

Table 2. POST /config/access/authorized_services/{id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
id	path	Required	Number (Integer)	text/plain	null
fields	header	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. POST /config/access/authorized_services/{id} request body details
Parameter	Data Type	MIME Type	Description	Sample
authorized_service	Object	application/json	Only the label, tenant_id, security_profile_id, user_role_id, and expiration_date fields can be set when updating an authorized service. All other fields are ignored.	{ "created_by": "String", "creation_date": 42, "expiration_date": 42, "id": 42, "label": "String", "last_used_date": 42, "security_profile_id": 42, "tenant_id": 42, "token": "String", "user_role_id": 42 }

Table 4. POST /config/access/authorized_services/{id} response codes
HTTP Response Code	Unique Code	Description
201		Authorized Service updated.
403	95104011	Authorized services cannot update themselves.
404	95104001	The authorized service ID does not exist.
422	95104002	The authorized service security_profile_id provided must exist.
422	95104003	The authorized service user_role_id provided must exist.
422	95104004	The authorized service tenant_id provided must exist.
422	95104005	The tenant_id was provided, but the security_profile_id does not limit access to data in that tenant.
422	95104006	The authorized service label must be unique for all authorized services and users usernames.
422	95104007	If the authorized service is assigned the System Administrator permission, it must also be assigned the Admin security profile.
422	95104008	The authorized service can't be assigned the System Administrator permission, as well as a tenant.
422	95104009	The length of the label field cannot exceed 255 characters.
422	95104010	The expiration date must be between the creation date of the authorized service and the max expiration date from when the service was created.
422	95104013	Manage Local Only Authentication Setting permission required to perform action.
500	95104012	If there is an unexpected error that occurs.

Response Description

The updated authorized service structure.

label - String - The label of the authorized service. Authorized service labels and usernames must be unique between them.
tenant_id - Long - (Optional) the tenant ID of the authorized service. Access a list of tenants using /api/config/access/tenant_management/tenants. When set, this field will restrict the security_profile_id field to ones that are completely contained within the specified tenant.
security_profile_id - Long - The security profile ID of the authorized service. Access deployed security profiles using /api/config/security_profiles API.
user_role_id - Long - The user_role_id of the user. Access deployed user roles using /api/config/user_roles API.
expiration_date - Long - The time in milliseconds since epoch that this authorized service will expire. If this field is null, this authorized service does not expire. This field can be set to a time in the past, which will disable the authorized service.

Response Sample


{
    "created_by": "String",
    "creation_date": 42,
    "expiration_date": 42,
    "id": 42,
    "label": "String",
    "last_used_date": 42,
    "security_profile_id": 42,
    "tenant_id": 42,
    "token": "String",
    "user_role_id": 42
}