Skip to main content

List Account Activities

GET 
/account-activities

This gets a collection of account activities that satisfy the given query parameters.

Request​

Query Parameters

    requested-for string

    The identity that the activity was requested for. me indicates the current user. Mutually exclusive with regarding-identity.

    Example: 2c91808568c529c60168cca6f90c1313
    requested-by string

    The identity that requested the activity. me indicates the current user. Mutually exclusive with regarding-identity.

    Example: 2c91808568c529c60168cca6f90c1313
    regarding-identity string

    The specified identity will be either the requester or target of the account activity. me indicates the current user. Mutually exclusive with requested-for and requested-by.

    Example: 2c91808568c529c60168cca6f90c1313
    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true
    filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    type: eq, in, ge, gt, le, lt, ne, isnull, sw

    created: gt, lt, ge, le, eq, in, ne, isnull, sw

    modified: gt, lt, ge, le, eq, in, ne, isnull, sw

    Example: type eq "Identity Refresh"
    sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: type, created, modified

    Example: created

Responses​

List of account activities

Schema
  • Array [
    • id string

    Id of the account activity

    name string

    The name of the activity

    created date-time

    When the activity was first created

    modified date-timenullable

    When the activity was last modified

    completed date-timenullable

    When the activity was completed

    completionStatus objectnullable

    The status after completion.

    type stringnullable

    The type of action the activity performed. Please see the following list of types. This list may grow over time.

    • CloudAutomated
    • IdentityAttributeUpdate
    • appRequest
    • LifecycleStateChange
    • AccountStateUpdate
    • AccountAttributeUpdate
    • CloudPasswordRequest
    • Attribute Synchronization Refresh
    • Certification
    • Identity Refresh
    • Lifecycle Change Refresh

    Learn more here.

    requesterIdentitySummary objectnullable
    id string

    ID of this identity summary

    name string

    Human-readable display name of identity

    identityId string

    ID of the identity that this summary represents

    completed boolean

    Indicates if all access items for this summary have been decided on

    targetIdentitySummary objectnullable
    id string

    ID of this identity summary

    name string

    Human-readable display name of identity

    identityId string

    ID of the identity that this summary represents

    completed boolean

    Indicates if all access items for this summary have been decided on

    errors string[]nullable

    A list of error messages, if any, that were encountered.

    warnings string[]nullable

    A list of warning messages, if any, that were encountered.

    items object[]nullable

    Individual actions performed as part of this account activity

  • Array [
    • id string

    Item id

    name string

    Human-readable display name of item

    requested date-time

    Date and time item was requested

    approvalStatus objectnullable

    The state of a work item

    provisioningStatus ProvisioningState

    Possible values: [PENDING, FINISHED, UNVERIFIABLE, COMMITED, FAILED, RETRY]

    Provisioning state of an account activity item

    requesterComment objectnullable
    commenterId string

    Id of the identity making the comment

    commenterName string

    Human-readable display name of the identity making the comment

    body string

    Content of the comment

    date date-time

    Date and time comment was made

    reviewerIdentitySummary objectnullable
    id string

    ID of this identity summary

    name string

    Human-readable display name of identity

    identityId string

    ID of the identity that this summary represents

    completed boolean

    Indicates if all access items for this summary have been decided on

    reviewerComment objectnullable
    commenterId string

    Id of the identity making the comment

    commenterName string

    Human-readable display name of the identity making the comment

    body string

    Content of the comment

    date date-time

    Date and time comment was made

    operation objectnullable

    Represents an operation in an account activity item

    attribute stringnullable

    Attribute to which account activity applies

    value stringnullable

    Value of attribute

    nativeIdentity stringnullable

    Native identity in the target system to which the account activity applies

    sourceId string

    Id of Source to which account activity applies

    accountRequestInfo objectnullable

    If an account activity item is associated with an access request, captures details of that request.

    requestedObjectId string

    Id of requested object

    requestedObjectName string

    Human-readable name of requested object

    requestedObjectType RequestableObjectType

    Possible values: [ACCESS_PROFILE, ROLE, ENTITLEMENT]

    The currently supported requestable object types.

    clientMetadata objectnullable

    Arbitrary key-value pairs, if any were included in the corresponding access request item

    property name* string
    removeDate date-timenullable

    The date the role or access profile is no longer assigned to the specified identity.

  • ]
    • executionStatus ExecutionStatus

    Possible values: [EXECUTING, VERIFYING, TERMINATED, COMPLETED]

    The current state of execution.

    clientMetadata objectnullable

    Arbitrary key-value pairs, if any were included in the corresponding access request

    property name* string
  • ]
Loading...