Skip to main content

Get Identity Attribute

GET 

https://sailpoint.api.identitynow.com/v2024/identity-attributes/:name

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.

This gets an identity attribute for a given technical name.

Request

Path Parameters

    name stringrequired

    The attribute's technical name.

    Example: displayName

Header Parameters

    X-SailPoint-Experimental stringrequired

    Use this header to enable this experimental API.

    Default value: true
    Example: true

Responses

The identity attribute with the given name

Schema
    namestringrequired

    Identity attribute's technical name.

    Example: costCenter
    displayNamestring

    Identity attribute's business-friendly name.

    Example: Cost Center
    standardboolean

    Indicates whether the attribute is 'standard' or 'default'.

    Default value: false
    Example: false
    typestringnullable

    Identity attribute's type.

    Example: string
    multiboolean

    Indicates whether the identity attribute is multi-valued.

    Default value: false
    Example: false
    searchableboolean

    Indicates whether the identity attribute is searchable.

    Default value: false
    Example: false
    systemboolean

    Indicates whether the identity attribute is 'system', meaning that it doesn't have a source and isn't configurable.

    Default value: false
    Example: false
    sources object[]

    Identity attribute's list of sources - this specifies how the rule's value is derived.

  • Array [
  • typestring

    Attribute mapping type.

    Example: rule
    propertiesobject

    Attribute mapping properties.

    Example: {"ruleType":"IdentityAttribute","ruleName":"Cloud Promote Identity Attribute"}
  • ]

Authorization: oauth2

type: Personal Access Token
scopes: idn:identity-profile-attribute:read
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://sailpoint.api.identitynow.com/v2024/identity-attributes/:name"
method := "GET"

client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)

if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Bearer <TOKEN>")

res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()

body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
Request Collapse all
Base URL
https://sailpoint.api.identitynow.com/v2024
Auth
Parameters
— pathrequired
— headerrequired
ResponseClear

Click the Send API Request button above and see the response here!