Skip to main content

Search property definitions

GET 
/nevisidm/api/core/v1/properties

Since: 8.2605.0, 9.2605.0

Required permission(s): AccessControl.PropertyView

Returns property definitions matching the specified filter criteria.

All filter parameters are optional and can be combined. If no filters are provided, all property definitions are returned. Results are served from the property cache for optimal performance.

Request​

Query Parameters

    scope string

    Possible values: [APPLICATION_GLOBAL, UNIT_GLOBAL, PROFILE_GLOBAL, PROFILE_FOR_APPLICATION_GLOBAL, PROFILE_FOR_APPLICATION, ROLE_FOR_APPLICATION, USER_GLOBAL, ENTERPRISE_ROLE_GLOBAL, CREDENTIAL_CERTIFICATE_GLOBAL, CREDENTIAL_GENERIC_GLOBAL, CREDENTIAL_MOBILE_SIGNATURE_GLOBAL, CREDENTIAL_SAML_FEDERATION_GLOBAL, CREDENTIAL_SECURITY_QUESTIONS_GLOBAL]

    Filter by property scope.

    Example: USER_GLOBAL
    type string

    Possible values: [ENUM, STRING]

    Filter by property type.

    Example: STRING
    clientExtId string

    Filter by client external ID. Returns properties belonging to this client or client-independent properties.

    Example: client-123
    applicationExtId string

    Filter by application external ID. Only applicable for scopes PROFILE_FOR_APPLICATION and ROLE_FOR_APPLICATION.

    Example: app-456
    name string

    Filter by property name (partial match, case-insensitive)

    Example: custom

Responses​

Property definitions found

Schema
    items object[]
  • Array [
    • created string

    Creation date of the entity.

    lastModified string

    Date when the entity was last modified.

    version int32

    Version used for optimistic locking.

    propertyId int64

    Unique identifier of the property.

    name string

    Name of the property. Must be unique within the same scope and client.

    description string

    Description of the property.

    type string

    Possible values: [ENUM, STRING]

    Type of the property.

    scope string

    Possible values: [APPLICATION_GLOBAL, UNIT_GLOBAL, PROFILE_GLOBAL, PROFILE_FOR_APPLICATION_GLOBAL, PROFILE_FOR_APPLICATION, ROLE_FOR_APPLICATION, USER_GLOBAL, ENTERPRISE_ROLE_GLOBAL, CREDENTIAL_CERTIFICATE_GLOBAL, CREDENTIAL_GENERIC_GLOBAL, CREDENTIAL_MOBILE_SIGNATURE_GLOBAL, CREDENTIAL_SAML_FEDERATION_GLOBAL, CREDENTIAL_SECURITY_QUESTIONS_GLOBAL]

    Scope of the property, determining which entity type it belongs to.

    encrypted boolean

    Indicates if the property values are encrypted.

    propagated boolean

    Indicates if the property values are propagated to other systems.

    mandatoryOnGui boolean

    Indicates if the property is mandatory on the GUI.

    stringMaxLen int32

    Maximum length for string values. Only applicable for STRING type properties.

    stringRegex string

    Regular expression pattern to validate string values. Only applicable for STRING type properties.

    accessCreate string

    Possible values: [READ_WRITE, READ_ONLY, OFF]

    Access level for creating the property value.

    accessModify string

    Possible values: [READ_WRITE, READ_ONLY, OFF]

    Access level for modifying the property value.

    uniquenessScope string

    Possible values: [ABSOLUTE, ABSOLUTE_USER, RELATIVE_UNIT, NONE]

    Uniqueness scope of the property. Defines how property values must be unique.

    guiPrecedence int32

    Precedence of the property on the GUI. Lower values are displayed first.

    displayName object

    Language-dependent display name of the property. Keys: EN, DE, FR, IT.

    property name* string
    applicationExtId string

    External ID of the application this property belongs to. Only applicable for scopes PROFILE_FOR_APPLICATION and ROLE_FOR_APPLICATION.

    clientExtId string

    External ID of the client this property belongs to. If not set, the property is client-independent.

    allowedValues object[]

    List of allowed values for ENUM type properties.

  • Array [
    • allowedValueId int64

    Unique identifier of the allowed value.

    value string

    The allowed value.

  • ]
  • ]
    • _pagination object
    continuationToken string

    The continuation token for fetching the next page of results generated from creation date and external id of the last entity

    limit int32

    The maximum number of results returned in a single page

    totalResult int64

    The total number of results available, only supported for selected endpoints, if returnTotalResultCount query-parameter is true

    _classifications object
    property name* string[]
  • Array [

    • string

  • ]
Loading...
Last updated on