GoodMemGoodMem
ReferenceAPIREST APIService Identities

Update a service identity

PUT /v1/service-identities/{id}: Updates only fields present in the request. Empty description clears that optional field. Ownership changes use the dedicated transfer endpoint.

PUT
/v1/service-identities/{id}

Updates only fields present in the request. Empty description clears that optional field. Ownership changes use the dedicated transfer endpoint.

Authorization

ApiKeyAuth
headerx-api-key<token>

Path Parameters

id*string

Service-identity UUID

Header Parameters

GoodMem-Timeout-Ms?integer

Optional waiting budget in milliseconds, measured from REST servlet ingress and shared across all internal gRPC calls. Supply one decimal integer from 1 to 86400000. Omission adds no deadline. Existing shorter deadlines still apply. Expiry returns HTTP 504 before streaming starts; after streaming starts, no successful completion event is sent. Use SSE or opt into GoodMem-Stream-Terminal for an explicit terminal outcome. Retrieval work is cooperatively cancelled. An accepted mutation may still commit after timeout or disconnect; a failed response does not imply rollback.

Formatint64
Range1 <= value <= 86400000

Request Body

application/json
  1. body

Updates explicitly present profile fields. Empty description clears it; omitted fields remain unchanged. Ownership is changed only through the transfer endpoint.

displayName*|

Replacement display name. A present blank value is invalid.

Length1 <= length <= 255
Example"production-search-v2"
description?|

Replacement description. An empty string clears the description.

Example"Updated production workload"
replaceLabels?|

Complete replacement label map; an empty map clears all labels and is mutually exclusive with mergeLabels. At most 20 entries; keys and values contain at most 255 characters; keys use [a-z0-9._-].

Propertiesproperties <= 20
Example
{  "team": "platform"}
mergeLabels?|

Labels to upsert; must contain at least one entry and is mutually exclusive with replaceLabels. The final stored map may contain at most 20 entries; keys and values contain at most 255 characters; keys use [a-z0-9._-].

Properties1 <= properties <= 20
Example
{  "environment": "production"}

Response Body

Service identity updated

application/json
  1. response

A durable production workload identity. Credentials, grants, and roles are separate resources and are not included.

serviceIdentityId*string

OUTPUT_ONLY; immutable service-identity UUID.

Formatuuid
Example"550e8400-e29b-41d4-a716-446655440000"
displayName*string

OUTPUT_ONLY; unique operator-facing display name.

Example"production-search"
description?|

OUTPUT_ONLY; optional operator description.

ownerPrincipalId*string

OUTPUT_ONLY; current administrative owner principal UUID.

Formatuuid
creatorPrincipalId*string

OUTPUT_ONLY; immutable HUMAN creator-principal UUID.

Formatuuid
labels*

OUTPUT_ONLY; mutable labels. At most 20 entries; keys and values contain at most 255 characters; keys use [a-z0-9._-].

Propertiesproperties <= 20
Example
{  "environment": "production",  "team": "search"}
deletedAt?|

OUTPUT_ONLY; permanent deletion time in milliseconds, absent while active.

Formatint64
Example1620200000000
deletedById?|

OUTPUT_ONLY; exact deleting actor UUID, absent while active.

Formatuuid
createdAt*integer

OUTPUT_ONLY; creation time in milliseconds since the epoch.

Formatint64
Example1620000000000
updatedAt*integer

OUTPUT_ONLY; most recent mutation time in milliseconds since the epoch.

Formatint64
Example1620100000000
createdById*string

OUTPUT_ONLY; exact creating actor UUID.

Formatuuid
updatedById*string

OUTPUT_ONLY; exact actor UUID for the most recent mutation.

Formatuuid
Example Request
curl -X PUT 'https://your-goodmem-server.example.com/v1/service-identities/550e8400-e29b-41d4-a716-446655440000' \  -H 'GoodMem-Timeout-Ms: 30000' \  -H 'Content-Type: application/json' \  -d '{  "displayName": "production-search-v2"}'
Example Response
{  "serviceIdentityId": "550e8400-e29b-41d4-a716-446655440000",  "displayName": "production-search",  "description": "string",  "ownerPrincipalId": "c8b7819f-5f12-46fd-a2bb-632aece82193",  "creatorPrincipalId": "9dd98014-def4-41d6-819d-7db1f82d4d60",  "labels": {    "environment": "production",    "team": "search"  },  "deletedAt": 1620200000000,  "deletedById": "8ef578ad-7f1e-4656-b48b-b1b4a9aaa1cb",  "createdAt": 1620000000000,  "updatedAt": 1620100000000,  "createdById": "e13e432a-5323-4484-a91d-b5969bc564d9",  "updatedById": "d8bc6076-4141-4a88-80b9-0eb31643066f"}