Skip to main content

Create a Dimension

POST 

/roles/:roleId/dimensions

This API creates a dimension. You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API. Additionally, a ROLE_SUBADMIN cannot create a dimension that includes an access profile or entitlement if that access profile or entitlement is linked to a source that the ROLE_SUBADMIN is not associated with. The maximum supported length for the description field is 2000 characters.

Request

Path Parameters

    roleId stringrequired

    Parent Role Id of the dimension.

    Example: 6603fba3004f43c687610a29195252ce

Body

required

    id string

    The id of the Dimension. This field must be left null when creating a dimension, otherwise a 400 Bad Request error will result.

    name stringrequired

    Possible values: <= 128 characters

    The human-readable display name of the Dimension

    description stringnullable

    A human-readable description of the Dimension

    owner

    object

    required

    The owner of this object.

    type string

    Possible values: [IDENTITY]

    Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.

    id string

    Identity id

    name string

    Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.

    accessProfiles

    object[]

    nullable

  • Array [

  • id string

    ID of the Access Profile

    type string

    Possible values: [ACCESS_PROFILE]

    Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result.

    name string

    Human-readable display name of the Access Profile. This field is ignored on input.

  • ]

  • entitlements

    object[]

  • Array [

  • type string

    Possible values: [ENTITLEMENT]

    Entitlement's DTO type.

    id string

    Entitlement's ID.

    name stringnullable

    Entitlement's display name.

  • ]

  • membership

    object

    nullable

    When present, specifies that the Dimension is to be granted to Identities which either satisfy specific criteria.

    type DimensionMembershipSelectorType (string)

    Possible values: [STANDARD]

    This enum characterizes the type of a Dimension's membership selector. Only the STANDARD type supported:

    STANDARD: Indicates that Dimension membership is defined in terms of a criteria expression

    criteria

    object

    nullable

    Defines STANDARD type Dimension membership

    operation DimensionCriteriaOperation (string)

    Possible values: [EQUALS, AND, OR]

    An operation

    key

    object

    nullable

    Refers to a specific Identity attribute used in Dimension membership criteria.

    type DimensionCriteriaKeyType (string)required

    Possible values: [IDENTITY]

    Indicates whether the associated criteria represents an expression on identity attributes.

    property stringrequired

    The name of the identity attribute to which the associated criteria applies.

    stringValue stringnullable

    String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is EQUALS, this field is required. Otherwise, specifying it is an error.

    children

    object[]

    nullable

    Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.

  • Array [

  • operation DimensionCriteriaOperation (string)

    Possible values: [EQUALS, AND, OR]

    An operation

    key

    object

    nullable

    Refers to a specific Identity attribute used in Dimension membership criteria.

    type DimensionCriteriaKeyType (string)required

    Possible values: [IDENTITY]

    Indicates whether the associated criteria represents an expression on identity attributes.

    property stringrequired

    The name of the identity attribute to which the associated criteria applies.

    stringValue stringnullable

    String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error.

    children

    object[]

    nullable

    Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.

  • Array [

  • operation DimensionCriteriaOperation (string)

    Possible values: [EQUALS, AND, OR]

    An operation

    key

    object

    nullable

    Refers to a specific Identity attribute used in Dimension membership criteria.

    type DimensionCriteriaKeyType (string)required

    Possible values: [IDENTITY]

    Indicates whether the associated criteria represents an expression on identity attributes.

    property stringrequired

    The name of the identity attribute to which the associated criteria applies.

    stringValue string

    String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error.

  • ]

  • ]

  • parentId stringnullable

    The ID of the parent role. This field can be left null when creating a dimension, but if provided, it must match the role ID specified in the path variable of the API call.

Responses

Dimension created

Schema

    id string

    The id of the Dimension. This field must be left null when creating a dimension, otherwise a 400 Bad Request error will result.

    name stringrequired

    Possible values: <= 128 characters

    The human-readable display name of the Dimension

    created date-time

    Date the Dimension was created

    modified date-time

    Date the Dimension was last modified.

    description stringnullable

    A human-readable description of the Dimension

    owner

    object

    required

    The owner of this object.

    type string

    Possible values: [IDENTITY]

    Owner type. This field must be either left null or set to 'IDENTITY' on input, otherwise a 400 Bad Request error will result.

    id string

    Identity id

    name string

    Human-readable display name of the owner. It may be left null or omitted in a POST or PATCH. If set, it must match the current value of the owner's display name, otherwise a 400 Bad Request error will result.

    accessProfiles

    object[]

    nullable

  • Array [

  • id string

    ID of the Access Profile

    type string

    Possible values: [ACCESS_PROFILE]

    Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result.

    name string

    Human-readable display name of the Access Profile. This field is ignored on input.

  • ]

  • entitlements

    object[]

  • Array [

  • type string

    Possible values: [ENTITLEMENT]

    Entitlement's DTO type.

    id string

    Entitlement's ID.

    name stringnullable

    Entitlement's display name.

  • ]

  • membership

    object

    nullable

    When present, specifies that the Dimension is to be granted to Identities which either satisfy specific criteria.

    type DimensionMembershipSelectorType (string)

    Possible values: [STANDARD]

    This enum characterizes the type of a Dimension's membership selector. Only the STANDARD type supported:

    STANDARD: Indicates that Dimension membership is defined in terms of a criteria expression

    criteria

    object

    nullable

    Defines STANDARD type Dimension membership

    operation DimensionCriteriaOperation (string)

    Possible values: [EQUALS, AND, OR]

    An operation

    key

    object

    nullable

    Refers to a specific Identity attribute used in Dimension membership criteria.

    type DimensionCriteriaKeyType (string)required

    Possible values: [IDENTITY]

    Indicates whether the associated criteria represents an expression on identity attributes.

    property stringrequired

    The name of the identity attribute to which the associated criteria applies.

    stringValue stringnullable

    String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is EQUALS, this field is required. Otherwise, specifying it is an error.

    children

    object[]

    nullable

    Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.

  • Array [

  • operation DimensionCriteriaOperation (string)

    Possible values: [EQUALS, AND, OR]

    An operation

    key

    object

    nullable

    Refers to a specific Identity attribute used in Dimension membership criteria.

    type DimensionCriteriaKeyType (string)required

    Possible values: [IDENTITY]

    Indicates whether the associated criteria represents an expression on identity attributes.

    property stringrequired

    The name of the identity attribute to which the associated criteria applies.

    stringValue stringnullable

    String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error.

    children

    object[]

    nullable

    Array of child criteria. Required if the operation is AND or OR, otherwise it must be left null. A maximum of three levels of criteria are supported, including leaf nodes. Additionally, AND nodes can only be children or OR nodes and vice-versa.

  • Array [

  • operation DimensionCriteriaOperation (string)

    Possible values: [EQUALS, AND, OR]

    An operation

    key

    object

    nullable

    Refers to a specific Identity attribute used in Dimension membership criteria.

    type DimensionCriteriaKeyType (string)required

    Possible values: [IDENTITY]

    Indicates whether the associated criteria represents an expression on identity attributes.

    property stringrequired

    The name of the identity attribute to which the associated criteria applies.

    stringValue string

    String value to test the Identity attribute specified in the key w/r/t the specified operation. If this criteria is a leaf node, that is, if the operation is one of EQUALS, this field is required. Otherwise, specifying it is an error.

  • ]

  • ]

  • parentId stringnullable

    The ID of the parent role. This field can be left null when creating a dimension, but if provided, it must match the role ID specified in the path variable of the API call.

Loading...