diff --git a/static/api-specs/idn/beta/schemas/Identity.yaml b/static/api-specs/idn/beta/schemas/Identity.yaml index ae0cb8bbc..2b0b2a003 100644 --- a/static/api-specs/idn/beta/schemas/Identity.yaml +++ b/static/api-specs/idn/beta/schemas/Identity.yaml @@ -40,6 +40,7 @@ allOf: isManager: type: boolean description: Whether this identity is a manager of another identity + default: false example: true lastRefresh: type: string @@ -50,3 +51,6 @@ allOf: type: object description: A map with the identity attributes for the identity example: '{"uid":"Walter White","firstname":"walter","cloudStatus":"UNREGISTERED","displayName":"Walter White","identificationNumber":"942","lastSyncDate":1470348809380,"email":"walter@gmail.com","lastname":"white"}' + lifecycleState: + $ref: '../../v3/schemas/LifecycleStateDto.yaml' + description: Lifecycle state details that include lifecycle state name and whether this lifecycle state has been set manually diff --git a/static/api-specs/idn/v3/schemas/LifecycleStateDto.yaml b/static/api-specs/idn/v3/schemas/LifecycleStateDto.yaml new file mode 100644 index 000000000..eb6d90666 --- /dev/null +++ b/static/api-specs/idn/v3/schemas/LifecycleStateDto.yaml @@ -0,0 +1,13 @@ +type: object +properties: + stateName: + type: string + description: The name of the lifecycle state + example: 'active' + manuallyUpdated: + type: boolean + description: Whether the lifecycle state has been manually or automatically set + example: true +required: + - stateName + - manuallyUpdated