Skip to main content

Role assignment details

GET 

/identities/:identityId/role-assignments/:assignmentId

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Role assignment details

Request

Path Parameters

    identityId stringrequired

    Identity Id

    Example: ef38f94347e94562b5bb8424a56397d8
    assignmentId stringrequired

    Assignment Id

    Example: 1cbb0705b38c4226b1334eadd8874086

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Responses

A role assignment object

Schema

    id string

    Assignment Id

    role

    object

    Role Id and Name related to this assignment

    id string

    the application ID

    name string

    the application name

    comments string

    Comments added by the user when the assignment was made

    assignmentSource string

    Source describing how this assignment was made

    assigner

    object

    The identity that performed the assignment. This could be blank or system

    id string

    the application ID

    name string

    the application name

    assignedDimensions

    object[]

    Dimensions assigned related to this role

  • Array [

  • id string

    the application ID

    name string

    the application name

  • ]

  • assignmentContext

    object

    The context around the role assignment

    requested

    object

    contextAttributes

    object[]

  • Array [

  • attribute string

    The name of the attribute

    value

    object

    The value of the attribute. This can be either a string or a multi-valued string

    oneOf

    string

    derived boolean

    True if the attribute was derived.

  • ]

  • matched

    object[]

  • Array [

  • roleRef

    object

    Role Id and Name related to this match

    id string

    the application ID

    name string

    the application name

    matchedAttributes

    object[]

  • Array [

  • attribute string

    The name of the attribute

    value

    object

    The value of the attribute. This can be either a string or a multi-valued string

    oneOf

    string

    derived boolean

    True if the attribute was derived.

  • ]

  • ]

  • computedDate string

    Date that the assignment will was evaluated

    accountTargets

    object[]

  • Array [

  • source

    object

    Source Id and Name related to this assignment

    id string

    the application ID

    name string

    the application name

    accountInfo

    object

    nativeIdentity string

    The unique ID of the account generated by the source system

    displayName string

    Display name for this account

    uuid string

    UUID associated with this account

    roleName string

    Specific role name for this target if using multiple accounts

  • ]

  • removeDate string

    Date that the assignment will be removed

Loading...